vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/er/api-ref/AcceptAttachment.html
fanqinying ccc163eb84 ER API 20240805 version 
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: fanqinying <fanqinying@huawei.com>
Co-committed-by: fanqinying <fanqinying@huawei.com>
2024-11-21 11:14:33 +00:00

246 lines
18 KiB
HTML
Raw Blame History

<a name="AcceptAttachment"></a><a name="AcceptAttachment"></a>
<h1 class="topictitle1">Accepting a Shared Attachment</h1>
<div id="body1708331107508"><div class="section" id="AcceptAttachment__section1246364020572"><h4 class="sectiontitle">Function</h4><p id="AcceptAttachment__p1463240185717">This API is used to accept a shared attachment.</p>
</div>
<div class="section" id="AcceptAttachment__section146334011573"><h4 class="sectiontitle">URI</h4><p id="AcceptAttachment__p104632407578">POST /v3/{project_id}/enterprise-router/{er_id}/attachments/{attachment_id}/accept</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="AcceptAttachment__table846454014571" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="AcceptAttachment__row64644402570"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="AcceptAttachment__p34642409571">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="AcceptAttachment__p146424085712">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="AcceptAttachment__p1246534045713">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="AcceptAttachment__p104657400572">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="AcceptAttachment__row1246419405578"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="AcceptAttachment__p184651540145710">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="AcceptAttachment__p5465194015571">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="AcceptAttachment__p1465140195713">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="AcceptAttachment__p84651440145719">Project ID</p>
</td>
</tr>
<tr id="AcceptAttachment__row12464144015711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="AcceptAttachment__p1146554025710">er_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="AcceptAttachment__p204653401577">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="AcceptAttachment__p124656404579">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="AcceptAttachment__p7466194018578">Enterprise router ID</p>
</td>
</tr>
<tr id="AcceptAttachment__row3464114015578"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="AcceptAttachment__p13466164019578">attachment_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="AcceptAttachment__p946614095714">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="AcceptAttachment__p1146664015710">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="AcceptAttachment__p7466440175718">Attachment ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="AcceptAttachment__section174661940165717"><h4 class="sectiontitle">Request Parameters</h4><p id="AcceptAttachment__p6466154035710">None</p>
</div>
<div class="section" id="AcceptAttachment__section1446617406571"><h4 class="sectiontitle">Response Parameters</h4><p id="AcceptAttachment__p846618404576"><strong id="AcceptAttachment__b6466184095710">Status code: 202</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="AcceptAttachment__response_AttachmentResponseBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="AcceptAttachment__row1846612403577"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="AcceptAttachment__p104671540195711">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="AcceptAttachment__p1467124065718">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="AcceptAttachment__p16467124005712">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="AcceptAttachment__row1846694016578"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="AcceptAttachment__p446764013579">attachment</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="AcceptAttachment__p646754019574"><a href="#AcceptAttachment__response_AttachmentResponse">AttachmentResponse</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="AcceptAttachment__p44671040155713">Attachment basic information</p>
</td>
</tr>
<tr id="AcceptAttachment__row15467144015571"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="AcceptAttachment__p44671640145715">request_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="AcceptAttachment__p6467340195711">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="AcceptAttachment__p3467740195720">Request ID</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="AcceptAttachment__response_AttachmentResponse"></a><a name="response_AttachmentResponse"></a><table cellpadding="4" cellspacing="0" summary="" id="AcceptAttachment__response_AttachmentResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>AttachmentResponse</caption><thead align="left"><tr id="AcceptAttachment__row9468174017576"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="AcceptAttachment__p8468140105716">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="AcceptAttachment__p1046804019573">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="AcceptAttachment__p1046804017578">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="AcceptAttachment__row14688405570"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="AcceptAttachment__p84691740185711">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="AcceptAttachment__p10469340165719">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="AcceptAttachment__p7469124015717">Attachment name</p>
</td>
</tr>
<tr id="AcceptAttachment__row204681404572"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="AcceptAttachment__p18469840155715">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="AcceptAttachment__p34699404578">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="AcceptAttachment__p34695407579">Attachment ID</p>
</td>
</tr>
<tr id="AcceptAttachment__row134682404573"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="AcceptAttachment__p946944018579">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="AcceptAttachment__p1246984065712">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="AcceptAttachment__p1469114095717">Supplementary information</p>
</td>
</tr>
<tr id="AcceptAttachment__row104682407572"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="AcceptAttachment__p204691740145716">state</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="AcceptAttachment__p1346919402573">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="AcceptAttachment__p1046914035717">Attachment status. Value options: <strong id="AcceptAttachment__b446994012578">pending</strong>, <strong id="AcceptAttachment__b114701140145716">available</strong>, <strong id="AcceptAttachment__b0470740125719">modifying</strong>, <strong id="AcceptAttachment__b154701240155720">deleting</strong>, <strong id="AcceptAttachment__b047024014573">deleted</strong>, <strong id="AcceptAttachment__b547016409572">failed</strong>, <strong id="AcceptAttachment__b204701340125710">pending_acceptance</strong>, <strong id="AcceptAttachment__b847024011574">rejected</strong>, and <strong id="AcceptAttachment__b8470134014576">initiating_request</strong></p>
</td>
</tr>
<tr id="AcceptAttachment__row1468154025711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="AcceptAttachment__p15470240195713">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="AcceptAttachment__p9470164025716">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="AcceptAttachment__p1747084014572">Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ</p>
</td>
</tr>
<tr id="AcceptAttachment__row3468740145713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="AcceptAttachment__p84701140125718">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="AcceptAttachment__p847010405577">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="AcceptAttachment__p1470164045718">Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ</p>
</td>
</tr>
<tr id="AcceptAttachment__row16468840175720"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="AcceptAttachment__p6470240115712">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="AcceptAttachment__p10470114035710">Array of <a href="#AcceptAttachment__response_Tag">Tag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="AcceptAttachment__p12470640185716">Attachment tags</p>
</td>
</tr>
<tr id="AcceptAttachment__row174681040175719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="AcceptAttachment__p9470184055711">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="AcceptAttachment__p1447024017579">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="AcceptAttachment__p104710409571">Project ID</p>
</td>
</tr>
<tr id="AcceptAttachment__row1346894012572"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="AcceptAttachment__p6471240175712">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="AcceptAttachment__p647124020579">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="AcceptAttachment__p3471124012574">Attached resource ID on its own service console</p>
</td>
</tr>
<tr id="AcceptAttachment__row546804075719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="AcceptAttachment__p4471144014578">resource_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="AcceptAttachment__p12471194045714">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="AcceptAttachment__p8471114019578">Attachment type.</p>
<ul id="AcceptAttachment__ul3471164013574"><li id="AcceptAttachment__li147164015572"><strong id="AcceptAttachment__b54717402579">vpc</strong>: VPC attachment</li></ul>
</td>
</tr>
<tr id="AcceptAttachment__row11468164055713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="AcceptAttachment__p6472104085718">resource_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="AcceptAttachment__p1047254018578">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="AcceptAttachment__p144727400574">ID of the project that the resource belongs to</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="AcceptAttachment__response_Tag"></a><a name="response_Tag"></a><table cellpadding="4" cellspacing="0" summary="" id="AcceptAttachment__response_Tag" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Tag</caption><thead align="left"><tr id="AcceptAttachment__row114723404573"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="AcceptAttachment__p174721640105714">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="AcceptAttachment__p12472184085712">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="AcceptAttachment__p647204035715">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="AcceptAttachment__row2047213403574"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="AcceptAttachment__p04731640165717">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="AcceptAttachment__p1247384019575">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="AcceptAttachment__p5473204010576">Tag key. The value contain up to 128 characters (36 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).</p>
<p id="AcceptAttachment__p44731402579">Minimum: <strong id="AcceptAttachment__b7473104035715">1</strong></p>
<p id="AcceptAttachment__p14473134015718">Maximum: <strong id="AcceptAttachment__b1947394065711">128</strong></p>
</td>
</tr>
<tr id="AcceptAttachment__row8472640165711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="AcceptAttachment__p7473164045715">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="AcceptAttachment__p4473204014575">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="AcceptAttachment__p18473124011570">Tag value. The value contain up to 128 characters in API (43 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).</p>
<p id="AcceptAttachment__p24735402578">Minimum: <strong id="AcceptAttachment__b1147312402576">0</strong></p>
<p id="AcceptAttachment__p16473640195717">Maximum: <strong id="AcceptAttachment__b347374055711">128</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="AcceptAttachment__section1647312401573"><h4 class="sectiontitle">Example Requests</h4><p id="AcceptAttachment__p547354017574">Accepting a shared attachment</p>
<pre class="screen" id="AcceptAttachment__screen8473640125712">POST https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/6f83b848-8331-4271-ac0c-ef94b7686402/attachments/6f83b848-8331-4271-ac0c-ef94b7686401/accept</pre>
</div>
<div class="section" id="AcceptAttachment__section54731440165711"><h4 class="sectiontitle">Example Responses</h4><p id="AcceptAttachment__p16474640125717"><strong id="AcceptAttachment__b164741640175717">Status code: 202</strong></p>
<p id="AcceptAttachment__p147404035718">Accepted</p>
<pre class="screen" id="AcceptAttachment__screen44749400577">{
"attachment" : {
"id" : "6f83b848-8331-4271-ac0c-ef94b7686402,",
"name" : "vpc attachment,",
"description" : "VPC attachment",
"state" : "avaliable",
"created_at" : "2020-03-11T15:13:31Z",
"updated_at" : "2020-03-11T15:13:31Z",
"tags" : [ ],
"project_id" : "0605767a9980d5762fbcc00b3537e757",
"resource_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
"resource_type" : "vpc",
"resource_project_id" : null
},
"request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}</pre>
</div>
<div class="section" id="AcceptAttachment__section8475140135715"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="AcceptAttachment__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="AcceptAttachment__row18475104017577"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="AcceptAttachment__p2047516406579">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="AcceptAttachment__p74751240115717">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="AcceptAttachment__row1947514401579"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="AcceptAttachment__p4475740105717">202</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="AcceptAttachment__p13475184035719">Accepted</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="AcceptAttachment__section124753402574"><h4 class="sectiontitle">Error Codes</h4><p id="AcceptAttachment__p4475164055719">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="Attachments.html">Attachments</a></div>
</div>
</div>
View Git Blame Copy Permalink