forked from docs/doc-exports
Reviewed-by: Topchii, Maria <mtopchii@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: vladimirvshivkov <vshivkovvladimir@gmail.com> Co-committed-by: vladimirvshivkov <vshivkovvladimir@gmail.com>
579 lines
45 KiB
HTML
579 lines
45 KiB
HTML
<a name="CreateInstanceV2_1"></a><a name="CreateInstanceV2_1"></a>
|
|
|
|
<h1 class="topictitle1">Creating a Dedicated Gateway (Pay-Per-Use)</h1>
|
|
<div id="body138741503495"><div class="section" id="CreateInstanceV2_1__section3874115020496"><h4 class="sectiontitle">Function</h4><p id="CreateInstanceV2_1__p168747504493">This API is used to create a pay-per-use dedicated gateway.</p>
|
|
</div>
|
|
<div class="section" id="CreateInstanceV2_1__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="CreateInstanceV2_1__p1287511508497">POST /v2/{project_id}/apigw/instances</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateInstanceV2_1__table1875950174919" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="CreateInstanceV2_1__row11875125054919"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="CreateInstanceV2_1__p208751450134911">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="CreateInstanceV2_1__p6876135084911">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="CreateInstanceV2_1__p8876145074916">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="CreateInstanceV2_1__p11876155015498">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateInstanceV2_1__row387518506499"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateInstanceV2_1__p1987616506497">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="CreateInstanceV2_1__p38761250104917">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="CreateInstanceV2_1__p88767508491">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="CreateInstanceV2_1__p208761650134911">Project ID. For details about how to obtain it, see <a href="apig-api-180713009.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="CreateInstanceV2_1__section19876195014912"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateInstanceV2_1__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="CreateInstanceV2_1__row1987715504497"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="CreateInstanceV2_1__p16877850144920">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="CreateInstanceV2_1__p1887725015493">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="CreateInstanceV2_1__p118771550144914">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="CreateInstanceV2_1__p9877450144910">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateInstanceV2_1__row15877205064910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="CreateInstanceV2_1__p128771950154916">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="CreateInstanceV2_1__p118782050184919">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="CreateInstanceV2_1__p1687813503490">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="CreateInstanceV2_1__p178781250134919">User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateInstanceV2_1__request_InstanceCreateReq" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="CreateInstanceV2_1__row1587819509494"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="CreateInstanceV2_1__p087935064915">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="CreateInstanceV2_1__p108802507493">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="CreateInstanceV2_1__p1880135018499">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="CreateInstanceV2_1__p688075015499">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateInstanceV2_1__row18781450174912"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateInstanceV2_1__p388016501495">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateInstanceV2_1__p1188012504498">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateInstanceV2_1__p388035044914">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateInstanceV2_1__p1888015084917">Gateway description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row3878165013497"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateInstanceV2_1__p19880145018491">maintain_begin</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateInstanceV2_1__p5880145014493">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateInstanceV2_1__p788065019495">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateInstanceV2_1__p14881450154913">Start time of the maintenance time window. It must be in the format "xx:00:00". The value of xx can be 02, 06, 10, 14, 18, or 22.</p>
|
|
<p id="CreateInstanceV2_1__p1888117503494">During the maintenance time period, O&M personnel perform maintenance on the gateway. During this period, services can still be used, but occasionally there may be temporary interruptions. Scheduled maintenance occurs infrequently (typically once every several months).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row18878115024915"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateInstanceV2_1__p1988110504494">maintain_end</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateInstanceV2_1__p9881350204917">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateInstanceV2_1__p388155012491">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateInstanceV2_1__p6881155020499">End time of the maintenance time window. It must be in the format "xx:00:00". There is a 4-hour difference between the start time and end time.</p>
|
|
<p id="CreateInstanceV2_1__p988135074919">During the maintenance time period, O&M personnel perform maintenance on the gateway. During this period, services can still be used, but occasionally there may be temporary interruptions. Scheduled maintenance occurs infrequently (typically once every several months).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row38791950144913"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateInstanceV2_1__p148815504490">instance_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateInstanceV2_1__p17881350124912">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateInstanceV2_1__p688117506497">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateInstanceV2_1__p68827505491">Gateway name.</p>
|
|
<p id="CreateInstanceV2_1__p1882175044913">Minimum: <strong id="CreateInstanceV2_1__b98821504497">3</strong></p>
|
|
<p id="CreateInstanceV2_1__p888220508499">Maximum: <strong id="CreateInstanceV2_1__b15882195012498">64</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row987913505491"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateInstanceV2_1__p48823509497">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateInstanceV2_1__p1988285020498">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateInstanceV2_1__p688285019498">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateInstanceV2_1__p98821250134914">Gateway ID, which will be automatically generated if you do not specify this parameter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row587945011491"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateInstanceV2_1__p688285084915">spec_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateInstanceV2_1__p58821150194911">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateInstanceV2_1__p588265016499">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateInstanceV2_1__p68823506494">Gateway edition. Options:</p>
|
|
<ul id="CreateInstanceV2_1__ul7883150134918"><li id="CreateInstanceV2_1__li1288316509499">BASIC</li><li id="CreateInstanceV2_1__li138831350184917">PROFESSIONAL</li><li id="CreateInstanceV2_1__li18883145013491">ENTERPRISE</li><li id="CreateInstanceV2_1__li19883250134913">PLATINUM</li></ul>
|
|
<p id="CreateInstanceV2_1__p388418505490">Enumeration values:</p>
|
|
<ul id="CreateInstanceV2_1__ul16884750124916"><li id="CreateInstanceV2_1__li3884185010490"><strong id="CreateInstanceV2_1__b5884450104918">BASIC</strong></li><li id="CreateInstanceV2_1__li08849506491"><strong id="CreateInstanceV2_1__b17884205034911">PROFESSIONAL</strong></li><li id="CreateInstanceV2_1__li1988485018491"><strong id="CreateInstanceV2_1__b15884165054917">ENTERPRISE</strong></li><li id="CreateInstanceV2_1__li1588475004914"><strong id="CreateInstanceV2_1__b8884105014910">PLATINUM</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row387965074918"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateInstanceV2_1__p188585084915">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateInstanceV2_1__p16885155017492">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateInstanceV2_1__p1888555064915">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateInstanceV2_1__p19885155017496">VPC ID.</p>
|
|
<p id="CreateInstanceV2_1__p5886125084911">You can obtain it in either of the following ways:</p>
|
|
<ul id="CreateInstanceV2_1__ul1688665011499"><li id="CreateInstanceV2_1__li108861850144917">Method 1: Log in to the VPC console, and click the name of a VPC to view the VPC ID on the displayed details page.</li><li id="CreateInstanceV2_1__li1588619505499">Method 2: Call the corresponding VPC API. For details, see section "Querying VPCs" in the VPC API Reference.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row2879115017492"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateInstanceV2_1__p10886450154918">subnet_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateInstanceV2_1__p1788685004910">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateInstanceV2_1__p1886650134915">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateInstanceV2_1__p6886155054911">Subnet network ID.</p>
|
|
<p id="CreateInstanceV2_1__p9886195064912">You can obtain it in either of the following ways:</p>
|
|
<ul id="CreateInstanceV2_1__ul988685014491"><li id="CreateInstanceV2_1__li1088675024918">Method 1: Log in to the VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.</li><li id="CreateInstanceV2_1__li108861450104914">Method 2: Call the corresponding VPC API. For details, see section "Querying Subnets" in the VPC API Reference.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row287935017493"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateInstanceV2_1__p18886950134912">security_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateInstanceV2_1__p58871950144914">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateInstanceV2_1__p68871508491">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateInstanceV2_1__p10887950114919">ID of the security group to which the gateway belongs.</p>
|
|
<p id="CreateInstanceV2_1__p118872507492">You can obtain it in either of the following ways:</p>
|
|
<ul id="CreateInstanceV2_1__ul2088745016495"><li id="CreateInstanceV2_1__li488875020492">Method 1: Log in to the VPC console. Choose Access Control > Security Groups in the navigation pane. On the Security Groups page, click the target security group. Then view the security group ID on the displayed page.</li><li id="CreateInstanceV2_1__li9888105017496">Method 2: Call the corresponding VPC API. For details, see section "Querying Security Groups" in the VPC API Reference.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row487915502493"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateInstanceV2_1__p1388814506494">enterprise_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateInstanceV2_1__p1588945016491">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateInstanceV2_1__p1188910504491">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateInstanceV2_1__p888975064915">Enterprise project ID. This parameter is required if you are using an enterprise account.</p>
|
|
<p id="CreateInstanceV2_1__p7889550164918">You can obtain it in either of the following ways:</p>
|
|
<ul id="CreateInstanceV2_1__ul17889750114916"><li id="CreateInstanceV2_1__li6889125010492">Method 1: Log in to the Enterprise Project Management page, click the name of the target enterprise project, and view the project ID on the displayed page.</li><li id="CreateInstanceV2_1__li788914508495">Method 2: Call the corresponding project management API. For details, see section "Querying the Enterprise Project List" in the Enterprise Management API Reference.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row8879175013498"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateInstanceV2_1__p1388919508496">available_zone_ids</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateInstanceV2_1__p12889115014496">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateInstanceV2_1__p4889165084915">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateInstanceV2_1__p12889750164919">AZs.</p>
|
|
<p id="CreateInstanceV2_1__p148901050144914">An AZ is a physical region where resources use independent power supply and networks. AZs are physically isolated but interconnected through an internal network. To enhance application availability, create gateways in different AZs.</p>
|
|
<p id="CreateInstanceV2_1__p15890175012499">To obtain AZ information, call the API used to query AZs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row17879145004916"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateInstanceV2_1__p148901050184919">bandwidth_size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateInstanceV2_1__p1189015010494">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateInstanceV2_1__p689095074914">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateInstanceV2_1__p17890150114916">Outbound access bandwidth.</p>
|
|
<p id="CreateInstanceV2_1__p1589035016495">This parameter is required if public outbound access is enabled for the gateway. After you configure the bandwidth for the gateway, users can access resources on public networks.</p>
|
|
<p id="CreateInstanceV2_1__p58908506493">Default: <strong id="CreateInstanceV2_1__b5890155044910">5</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row16879135019494"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateInstanceV2_1__p6890105010492">bandwidth_charging_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateInstanceV2_1__p128909503491">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateInstanceV2_1__p4890950174915">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateInstanceV2_1__p198911506499">Billing type of the public outbound access bandwidth. This parameter is required if public outbound access is enabled for the gateway.</p>
|
|
<ul id="CreateInstanceV2_1__ul6891165054917"><li id="CreateInstanceV2_1__li17891195074912">bandwidth: billed by bandwidth</li><li id="CreateInstanceV2_1__li589145094913">traffic: billed by traffic</li></ul>
|
|
<p id="CreateInstanceV2_1__p28911650194916">Default: <strong id="CreateInstanceV2_1__b158911350204917">bandwidth</strong></p>
|
|
<p id="CreateInstanceV2_1__p11891185014912">Enumeration values:</p>
|
|
<ul id="CreateInstanceV2_1__ul1089120507494"><li id="CreateInstanceV2_1__li1189195074917"><strong id="CreateInstanceV2_1__b889115012493">bandwidth</strong></li><li id="CreateInstanceV2_1__li14891165094911"><strong id="CreateInstanceV2_1__b1889120504499">traffic</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row1487912508492"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateInstanceV2_1__p1589225014918">loadbalancer_provider</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateInstanceV2_1__p389285018496">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateInstanceV2_1__p38921550194912">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateInstanceV2_1__p1189295084918">Type of the load balancer used by the gateway.</p>
|
|
<ul id="CreateInstanceV2_1__ul7892550184917"><li id="CreateInstanceV2_1__li12892850174913">ELB</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row9879195012495"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateInstanceV2_1__p089365014491">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateInstanceV2_1__p5893145064919">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateInstanceV2_1__p18893115094913">Array of <a href="#CreateInstanceV2_1__request_TmsKeyValue">TmsKeyValue</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateInstanceV2_1__p1893350164919">Tags.</p>
|
|
<p id="CreateInstanceV2_1__p15893185011494">A maximum of 20 tags can be created for a gateway.</p>
|
|
<p id="CreateInstanceV2_1__p1389315014493">Array Length: <strong id="CreateInstanceV2_1__b78931850164917">0 - 20</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row987945014491"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateInstanceV2_1__p689310509497">vpcep_service_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateInstanceV2_1__p48937501491">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateInstanceV2_1__p148937505494">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateInstanceV2_1__p1893165017494">Name of a VPC endpoint service.</p>
|
|
<p id="CreateInstanceV2_1__p16894195018497">It can contain max. 16 characters, including letters, digits, hyphens (-), and underscores.</p>
|
|
<p id="CreateInstanceV2_1__p13894350114920">If this parameter is not specified, the system automatically generates a name in the "{region}.apig.{service_id}" format.</p>
|
|
<p id="CreateInstanceV2_1__p168942503494">If this parameter is specified, the system automatically generates a name in the "{region}.{vpcep_service_name}.{service_id}" format.</p>
|
|
<p id="CreateInstanceV2_1__p18894105017498">After the gateway is created, you can modify this name on the Gateways > VPC Endpoints page.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row14879145015493"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateInstanceV2_1__p1889416503490">ingress_bandwidth_size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateInstanceV2_1__p889435024916">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateInstanceV2_1__p889410503494">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateInstanceV2_1__p889415014918">Public inbound access bandwidth.</p>
|
|
<p id="CreateInstanceV2_1__p1689415016491">This parameter is required if public inbound access is enabled for the gateway and loadbalancer_provider is set to elb. After you bind an EIP to the gateway, users can access APIs in the gateway from public networks using the EIP.</p>
|
|
<p id="CreateInstanceV2_1__p3894135054910">Default: <strong id="CreateInstanceV2_1__b989425016493">5</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row14879750114910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateInstanceV2_1__p8894450144910">ingress_bandwidth_charging_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateInstanceV2_1__p11894155014491">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateInstanceV2_1__p178951450114919">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateInstanceV2_1__p1189535034911">Billing type of the public inbound access bandwidth. This parameter is required if public inbound access is enabled for the gateway and loadbalancer_provider is set to elb.</p>
|
|
<ul id="CreateInstanceV2_1__ul1689525011496"><li id="CreateInstanceV2_1__li16895145020494">bandwidth: billed by bandwidth</li><li id="CreateInstanceV2_1__li208951350104920">traffic: billed by traffic</li></ul>
|
|
<p id="CreateInstanceV2_1__p789595019494">Default: <strong id="CreateInstanceV2_1__b168959509497">bandwidth</strong></p>
|
|
<p id="CreateInstanceV2_1__p1389517501493">Enumeration values:</p>
|
|
<ul id="CreateInstanceV2_1__ul289512506490"><li id="CreateInstanceV2_1__li989535034919"><strong id="CreateInstanceV2_1__b1889565010498">bandwidth</strong></li><li id="CreateInstanceV2_1__li58952503497"><strong id="CreateInstanceV2_1__b208951850144913">traffic</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="CreateInstanceV2_1__request_TmsKeyValue"></a><a name="request_TmsKeyValue"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateInstanceV2_1__request_TmsKeyValue" frame="border" border="1" rules="all"><caption><b>Table 4 </b>TmsKeyValue</caption><thead align="left"><tr id="CreateInstanceV2_1__row68951550124912"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="CreateInstanceV2_1__p20896950204918">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="CreateInstanceV2_1__p6896155074910">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="CreateInstanceV2_1__p789613509494">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="CreateInstanceV2_1__p11481651104914">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateInstanceV2_1__row19896750164916"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateInstanceV2_1__p1948351204911">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateInstanceV2_1__p194995104920">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateInstanceV2_1__p249145114498">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateInstanceV2_1__p449451124910">Key.</p>
|
|
<p id="CreateInstanceV2_1__p15491851164918">Include UTF-8 letters, digits, spaces, or special characters (_.:=+-@).</p>
|
|
<p id="CreateInstanceV2_1__p16491851154915">Do not start with _sys_ because it is a system label.</p>
|
|
<p id="CreateInstanceV2_1__p12492512492">Minimum: <strong id="CreateInstanceV2_1__b7492051164919">1</strong></p>
|
|
<p id="CreateInstanceV2_1__p449751134915">Maximum: <strong id="CreateInstanceV2_1__b849135104910">128</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row14896165054915"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateInstanceV2_1__p64910513494">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateInstanceV2_1__p144917514499">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateInstanceV2_1__p174925117498">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateInstanceV2_1__p1849185114913">Value.</p>
|
|
<p id="CreateInstanceV2_1__p11494511495">You can enter letters, digits, and spaces or other special characters (_.:/=+-@) in UTF-8 format.</p>
|
|
<p id="CreateInstanceV2_1__p144910519491">Minimum: <strong id="CreateInstanceV2_1__b1049145114910">0</strong></p>
|
|
<p id="CreateInstanceV2_1__p1949185154914">Maximum: <strong id="CreateInstanceV2_1__b1649651184914">255</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="CreateInstanceV2_1__section64985144917"><h4 class="sectiontitle">Response Parameters</h4><p id="CreateInstanceV2_1__p749105119498"><strong id="CreateInstanceV2_1__b249135194915">Status code: 202</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateInstanceV2_1__response_InstanceCreateResp" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="CreateInstanceV2_1__row17898115094915"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="CreateInstanceV2_1__p04945154916">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="CreateInstanceV2_1__p164917517492">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="CreateInstanceV2_1__p194935114910">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateInstanceV2_1__row19898105044918"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateInstanceV2_1__p64975115498">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateInstanceV2_1__p124918512491">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateInstanceV2_1__p15491518493">Gateway ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row178989509496"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateInstanceV2_1__p549185144915">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateInstanceV2_1__p649135184912">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateInstanceV2_1__p184918513491">Information about the gateway creation task.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row789865015499"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateInstanceV2_1__p94935154917">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateInstanceV2_1__p1949105112494">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateInstanceV2_1__p1949851124915">Task ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="CreateInstanceV2_1__p549145184917"><strong id="CreateInstanceV2_1__b15491951114918">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateInstanceV2_1__response_ErrorMsg" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="CreateInstanceV2_1__row4901125015493"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="CreateInstanceV2_1__p1491051114911">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="CreateInstanceV2_1__p174935134911">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="CreateInstanceV2_1__p549135118496">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateInstanceV2_1__row13901105044913"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="CreateInstanceV2_1__p144925116494">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="CreateInstanceV2_1__p194945164919">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="CreateInstanceV2_1__p9491511499">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row790165084914"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="CreateInstanceV2_1__p1749185104917">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="CreateInstanceV2_1__p15497516492">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="CreateInstanceV2_1__p134935174916">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="CreateInstanceV2_1__p649151144918"><strong id="CreateInstanceV2_1__b15501051154920">Status code: 401</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateInstanceV2_1__response_ErrorMsg_1" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="CreateInstanceV2_1__row199023505497"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="CreateInstanceV2_1__p135085144912">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="CreateInstanceV2_1__p7506519491">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="CreateInstanceV2_1__p1150251184913">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateInstanceV2_1__row2090216500493"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="CreateInstanceV2_1__p75015116495">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="CreateInstanceV2_1__p1750185174914">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="CreateInstanceV2_1__p185085164911">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row12902950154916"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="CreateInstanceV2_1__p1650251104910">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="CreateInstanceV2_1__p1850155119492">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="CreateInstanceV2_1__p155005118492">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="CreateInstanceV2_1__p1450251114914"><strong id="CreateInstanceV2_1__b15501951184919">Status code: 403</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateInstanceV2_1__response_ErrorMsg_2" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="CreateInstanceV2_1__row1590385012499"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="CreateInstanceV2_1__p550165154916">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="CreateInstanceV2_1__p250165118496">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="CreateInstanceV2_1__p1250155144913">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateInstanceV2_1__row13903135012497"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="CreateInstanceV2_1__p55015111494">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="CreateInstanceV2_1__p55035184913">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="CreateInstanceV2_1__p6501751174913">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row190319503491"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="CreateInstanceV2_1__p165010519497">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="CreateInstanceV2_1__p1550185114915">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="CreateInstanceV2_1__p105095111490">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="CreateInstanceV2_1__p85019512492"><strong id="CreateInstanceV2_1__b1150135164918">Status code: 404</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateInstanceV2_1__response_ErrorMsg_3" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="CreateInstanceV2_1__row149043508491"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.1"><p id="CreateInstanceV2_1__p450651104912">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.2"><p id="CreateInstanceV2_1__p1450251154914">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.11.2.4.1.3"><p id="CreateInstanceV2_1__p1501551174911">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateInstanceV2_1__row1990517506494"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="CreateInstanceV2_1__p1950151104913">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="CreateInstanceV2_1__p25055154910">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="CreateInstanceV2_1__p1450105124918">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row15905105016499"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="CreateInstanceV2_1__p1750115114494">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="CreateInstanceV2_1__p145085164919">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="CreateInstanceV2_1__p750251204918">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="CreateInstanceV2_1__p105012512494"><strong id="CreateInstanceV2_1__b1150205112497">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateInstanceV2_1__response_ErrorMsg_4" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="CreateInstanceV2_1__row17906205084910"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.1"><p id="CreateInstanceV2_1__p85011514492">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.2"><p id="CreateInstanceV2_1__p3502051104912">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.13.2.4.1.3"><p id="CreateInstanceV2_1__p205095144920">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateInstanceV2_1__row690645010495"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="CreateInstanceV2_1__p1503519497">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="CreateInstanceV2_1__p65010514499">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="CreateInstanceV2_1__p55055116496">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row109061050154918"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="CreateInstanceV2_1__p105010519495">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="CreateInstanceV2_1__p350951114914">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="CreateInstanceV2_1__p45055154918">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="CreateInstanceV2_1__section35011512496"><h4 class="sectiontitle">Example Requests</h4><p id="CreateInstanceV2_1__p350151114912">Creating a gateway with network and security group configurations</p>
|
|
<pre class="screen" id="CreateInstanceV2_1__screen19501151174914">{
|
|
"available_zone_ids" : [ "xx-xxx-7b", "xx-xxx-7a" ],
|
|
"bandwidth_size" : 5,
|
|
"description" : "test create instance",
|
|
"enterprise_project_id" : "0",
|
|
"instance_name" : "apig-demo",
|
|
"maintain_begin" : "22:00:00",
|
|
"maintain_end" : "02:00:00",
|
|
"security_group_id" : "36d0ec18-bd10-4da7-86f3-ad7a5ddc55d7",
|
|
"spec_id" : "PROFESSIONAL",
|
|
"subnet_id" : "a938121c-11c4-4c91-b983-bc9acd347bb5",
|
|
"vpc_id" : "0957108c-257c-4ce0-9e93-527d279ce763"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="CreateInstanceV2_1__section1051195164910"><h4 class="sectiontitle">Example Responses</h4><p id="CreateInstanceV2_1__p14511751204919"><strong id="CreateInstanceV2_1__b1451751184910">Status code: 202</strong></p>
|
|
<p id="CreateInstanceV2_1__p651185111491">Accepted</p>
|
|
<pre class="screen" id="CreateInstanceV2_1__screen155112515498">{
|
|
"instance_id" : "6a7d71827fd54572b1f31aa9548fcc81",
|
|
"message" : "JOB_ASSIGNED_FOR_PROVISIONING_0003I:The job JOB-bdb370eb6f4c4c73b61b95a9da38beb5 has been assigned to the instance 6a7d71827fd54572b1f31aa9548fcc81 for running provisioning.",
|
|
"job_id" : "JOB-edbac2355fb7433e98f173ea2e452e2d"
|
|
}</pre>
|
|
<p id="CreateInstanceV2_1__p195165174917"><strong id="CreateInstanceV2_1__b2051155119493">Status code: 400</strong></p>
|
|
<p id="CreateInstanceV2_1__p6511751134918">Bad Request</p>
|
|
<pre class="screen" id="CreateInstanceV2_1__screen1551115184912">{
|
|
"error_code" : "APIC.7211",
|
|
"error_msg" : "Parameter value does not match the rules, parameter name[maintainBegin]"
|
|
}</pre>
|
|
<p id="CreateInstanceV2_1__p135155164913"><strong id="CreateInstanceV2_1__b551951124918">Status code: 401</strong></p>
|
|
<p id="CreateInstanceV2_1__p551351164913">Unauthorized</p>
|
|
<pre class="screen" id="CreateInstanceV2_1__screen85175184915">{
|
|
"error_code" : "APIC.7102",
|
|
"error_msg" : "Incorrect token or token resolution failed"
|
|
}</pre>
|
|
<p id="CreateInstanceV2_1__p165112519495"><strong id="CreateInstanceV2_1__b205125154913">Status code: 403</strong></p>
|
|
<p id="CreateInstanceV2_1__p151251174920">Forbidden</p>
|
|
<pre class="screen" id="CreateInstanceV2_1__screen1751185110492">{
|
|
"error_code" : "APIC.7106",
|
|
"error_msg" : "No permissions to request for the method"
|
|
}</pre>
|
|
<p id="CreateInstanceV2_1__p45195117492"><strong id="CreateInstanceV2_1__b151195164917">Status code: 404</strong></p>
|
|
<p id="CreateInstanceV2_1__p18511851174911">Not Found</p>
|
|
<pre class="screen" id="CreateInstanceV2_1__screen4512512496">{
|
|
"error_code" : "APIC.7301",
|
|
"error_msg" : "Instance spec not found"
|
|
}</pre>
|
|
<p id="CreateInstanceV2_1__p145117517498"><strong id="CreateInstanceV2_1__b135105114491">Status code: 500</strong></p>
|
|
<p id="CreateInstanceV2_1__p13512051184919">Internal Server Error</p>
|
|
<pre class="screen" id="CreateInstanceV2_1__screen55165115492">{
|
|
"error_code" : "APIC.9000",
|
|
"error_msg" : "Failed to request internal service"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="CreateInstanceV2_1__section185155117496"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateInstanceV2_1__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="CreateInstanceV2_1__row2910145004915"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="CreateInstanceV2_1__p1951451124910">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="CreateInstanceV2_1__p251051134918">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateInstanceV2_1__row2091016505498"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateInstanceV2_1__p1651451144918">202</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateInstanceV2_1__p1051175115493">Accepted</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row199108506492"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateInstanceV2_1__p35175154911">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateInstanceV2_1__p25113513496">Bad Request</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row691075012496"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateInstanceV2_1__p105111516491">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateInstanceV2_1__p115105164911">Unauthorized</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row17910450194918"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateInstanceV2_1__p1951195115496">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateInstanceV2_1__p165111517492">Forbidden</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row14910750194917"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateInstanceV2_1__p205115184912">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateInstanceV2_1__p155175111495">Not Found</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateInstanceV2_1__row7910185013495"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateInstanceV2_1__p25113517493">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateInstanceV2_1__p851135114498">Internal Server Error</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="CreateInstanceV2_1__section185115115499"><h4 class="sectiontitle">Error Codes</h4><p id="CreateInstanceV2_1__p1951145117497">See <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="ApicInstanceManagement_1.html">Gateway Management</a></div>
|
|
</div>
|
|
</div>
|
|
|