doc-exports/docs/smn/api-ref/smn_api_51007.html
Zaoxu, Li 152a7d9381 SMN API DOC
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
2024-06-20 15:01:38 +00:00

248 lines
22 KiB
HTML

<a name="smn_api_51007"></a><a name="smn_api_51007"></a>
<h1 class="topictitle1">Updating a Topic Policy</h1>
<div id="body1474599764596"><div class="section" id="smn_api_51007__section64935954"><h4 class="sectiontitle">Description</h4><ul id="smn_api_51007__ul33304380203733"><li id="smn_api_51007__li51147505203733">API name<p id="smn_api_51007__p38624841203741"><a name="smn_api_51007__li51147505203733"></a><a name="li51147505203733"></a>UpdateTopicAttribute</p>
</li></ul>
<ul id="smn_api_51007__ul20998054203745"><li id="smn_api_51007__li46884910203750">Function<p id="smn_api_51007__p4186593495020"><a name="smn_api_51007__li46884910203750"></a><a name="li46884910203750"></a>Update a topic policy.</p>
</li></ul>
</div>
<div class="section" id="smn_api_51007__section47552675"><h4 class="sectiontitle">URI</h4><ul id="smn_api_51007__ul30639779"><li id="smn_api_51007__li7322556">URI format<p id="smn_api_51007__p65903005"><a name="smn_api_51007__li7322556"></a><a name="li7322556"></a>PUT /v2/{project_id}/notifications/topics/{topic_urn}/attributes/{name}</p>
</li></ul>
<ul id="smn_api_51007__ul56256135"><li id="smn_api_51007__li36543171">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="smn_api_51007__table60453091" frame="border" border="1" rules="all"><thead align="left"><tr id="smn_api_51007__row31471768"><th align="left" class="cellrowborder" valign="top" width="24.80751924807519%" id="mcps1.3.2.3.1.1.1.5.1.1"><p id="smn_api_51007__p66185246"><strong id="smn_api_51007__b842352706191030">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.227677232276772%" id="mcps1.3.2.3.1.1.1.5.1.2"><p id="smn_api_51007__p59404709"><strong id="smn_api_51007__b593421527191713">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.447855214478555%" id="mcps1.3.2.3.1.1.1.5.1.3"><p id="smn_api_51007__p47052116"><strong id="smn_api_51007__b84235270619112">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.516948305169482%" id="mcps1.3.2.3.1.1.1.5.1.4"><p id="smn_api_51007__p53125076"><strong id="smn_api_51007__b84235270619115">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="smn_api_51007__row57297510"><td class="cellrowborder" valign="top" width="24.80751924807519%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="smn_api_51007__p10586695">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.227677232276772%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="smn_api_51007__p52215961">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.447855214478555%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="smn_api_51007__p1634435">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.516948305169482%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="smn_api_51007__p45137179155033">Project ID</p>
<p id="smn_api_51007__p65280430">See <a href="smn_api_66000.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="smn_api_51007__row9249362"><td class="cellrowborder" valign="top" width="24.80751924807519%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="smn_api_51007__p11000853">topic_urn</p>
</td>
<td class="cellrowborder" valign="top" width="23.227677232276772%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="smn_api_51007__p18653909">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.447855214478555%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="smn_api_51007__p34571641">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.516948305169482%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="smn_api_51007__p48839530">Unique resource ID of a topic. You can obtain it by referring to <a href="en-us_topic_0036016755.html">Querying Topics</a>.</p>
</td>
</tr>
<tr id="smn_api_51007__row3251307152236"><td class="cellrowborder" valign="top" width="24.80751924807519%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="smn_api_51007__p62029310152236">name</p>
</td>
<td class="cellrowborder" valign="top" width="23.227677232276772%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="smn_api_51007__p58318222152236">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.447855214478555%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="smn_api_51007__p26155522152236">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.516948305169482%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="smn_api_51007__p43921265152316">Specifies the policy name.</p>
<p id="smn_api_51007__p28391318113116">Only specified policy names are supported. For details, see <a href="smn_api_a1000.html">Topic Attribute List</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="smn_api_51007__section25320898"><h4 class="sectiontitle">Request</h4><ul id="smn_api_51007__ul36823012152431"><li id="smn_api_51007__li16783502185146">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="smn_api_51007__table16833793185146" frame="border" border="1" rules="all"><thead align="left"><tr id="smn_api_51007__row46280455185146"><th align="left" class="cellrowborder" valign="top" width="17.65%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="smn_api_51007__p57729347185146"><strong id="smn_api_51007__b2114289169">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.06%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="smn_api_51007__p45565556185146"><strong id="smn_api_51007__b338584593125">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.22%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="smn_api_51007__p66931458185146"><strong id="smn_api_51007__b323044994">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="35.07%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="smn_api_51007__p52739028185146"><strong id="smn_api_51007__b1600926852">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="smn_api_51007__row7465062185146"><td class="cellrowborder" valign="top" width="17.65%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="smn_api_51007__p690294185146">value</p>
</td>
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="smn_api_51007__p55913834185146">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25.22%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="smn_api_51007__p32726699185146">String</p>
</td>
<td class="cellrowborder" valign="top" width="35.07%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="smn_api_51007__p33616928185146">Topic attribute value</p>
<ul id="smn_api_51007__ul8424824131612"><li id="smn_api_51007__li1142562416168">If you set <strong id="smn_api_51007__b612811563913">name</strong> to <strong id="smn_api_51007__b1812818561692">access_policy</strong>, <strong id="smn_api_51007__b8129956098">value</strong> is the topic attributes, and the maximum length of <strong id="smn_api_51007__b112912561896">value</strong> is 30 KB.</li><li id="smn_api_51007__li84251246166">If you set <strong id="smn_api_51007__b10657859101">name</strong> to <strong id="smn_api_51007__b1658195121012">introduction</strong>, <strong id="smn_api_51007__b196581513106">value</strong> is the topic introduction, and the maximum length of <strong id="smn_api_51007__b16599571016">value</strong> is 120 bytes.</li></ul>
<p id="smn_api_51007__p5140847203117">For details, see <a href="#smn_api_51007__table53240944112753">Table 1</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="smn_api_51007__table53240944112753"></a><a name="table53240944112753"></a><table cellpadding="4" cellspacing="0" summary="" id="smn_api_51007__table53240944112753" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Topic attribute values</caption><thead align="left"><tr id="smn_api_51007__row21987414112753"><th align="left" class="cellrowborder" valign="top" width="21.709999999999997%" id="mcps1.3.3.2.1.2.2.4.1.1"><p id="smn_api_51007__p35443943112753"><strong id="smn_api_51007__b115563436368">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.22%" id="mcps1.3.3.2.1.2.2.4.1.2"><p id="smn_api_51007__p1722161112753"><strong id="smn_api_51007__b15203449370">Description</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.07%" id="mcps1.3.3.2.1.2.2.4.1.3"><p id="smn_api_51007__p47496205112753">Constraint</p>
</th>
</tr>
</thead>
<tbody><tr id="smn_api_51007__row44101580112753"><td class="cellrowborder" valign="top" width="21.709999999999997%" headers="mcps1.3.3.2.1.2.2.4.1.1 "><p id="smn_api_51007__p36150079112753">Version</p>
</td>
<td class="cellrowborder" valign="top" width="45.22%" headers="mcps1.3.3.2.1.2.2.4.1.2 "><p id="smn_api_51007__p42475248112753">Policy specification version</p>
</td>
<td class="cellrowborder" valign="top" width="33.07%" headers="mcps1.3.3.2.1.2.2.4.1.3 "><p id="smn_api_51007__p17943058112753">Only <strong id="smn_api_51007__b842352706145948">2016-09-07</strong> is supported.</p>
</td>
</tr>
<tr id="smn_api_51007__row46405782112753"><td class="cellrowborder" valign="top" width="21.709999999999997%" headers="mcps1.3.3.2.1.2.2.4.1.1 "><p id="smn_api_51007__p61369906112753">Id</p>
</td>
<td class="cellrowborder" valign="top" width="45.22%" headers="mcps1.3.3.2.1.2.2.4.1.2 "><p id="smn_api_51007__p4906500112753">Policy ID, which uniquely identifies a policy</p>
</td>
<td class="cellrowborder" valign="top" width="33.07%" headers="mcps1.3.3.2.1.2.2.4.1.3 "><p id="smn_api_51007__p61882243112753"><strong id="smn_api_51007__b9568121711213">Id</strong> must be specified.</p>
</td>
</tr>
<tr id="smn_api_51007__row39288912112753"><td class="cellrowborder" valign="top" width="21.709999999999997%" headers="mcps1.3.3.2.1.2.2.4.1.1 "><p id="smn_api_51007__p14998859112753">Statement</p>
</td>
<td class="cellrowborder" valign="top" width="45.22%" headers="mcps1.3.3.2.1.2.2.4.1.2 "><p id="smn_api_51007__p1139155615212">Statements used to configure a topic policy. Each topic policy may contain one or more statements. You can use statements to grant topic permissions to other users or cloud services.</p>
</td>
<td class="cellrowborder" valign="top" width="33.07%" headers="mcps1.3.3.2.1.2.2.4.1.3 "><p id="smn_api_51007__p31968219112753">A policy must contain at least one statement. For details about elements in a statement, see <a href="#smn_api_51007__table13574080155334">Table 2</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="smn_api_51007__table13574080155334"></a><a name="table13574080155334"></a><table cellpadding="4" cellspacing="0" summary="" id="smn_api_51007__table13574080155334" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Statement elements description</caption><thead align="left"><tr id="smn_api_51007__row2428006155334"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.1.3.2.4.1.1"><p id="smn_api_51007__p66371740155519"><strong id="smn_api_51007__b43082088194323">Element</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33%" id="mcps1.3.3.2.1.3.2.4.1.2"><p id="smn_api_51007__p66616597155519"><strong id="smn_api_51007__b215516115112">Description</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.1.3.2.4.1.3"><p id="smn_api_51007__p43791157155519">Constraint</p>
</th>
</tr>
</thead>
<tbody><tr id="smn_api_51007__row5501174215551"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.1.3.2.4.1.1 "><p id="smn_api_51007__p2745813215551">Sid</p>
</td>
<td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.1.3.2.4.1.2 "><p id="smn_api_51007__p951625815551">Statement ID</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.1.3.2.4.1.3 "><p id="smn_api_51007__p3261944415551">The statement ID must be unique, for example, <strong id="smn_api_51007__b84235270620952">statement01</strong> or <strong id="smn_api_51007__b39889324202233">statement02</strong>.</p>
</td>
</tr>
<tr id="smn_api_51007__row2102549615551"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.1.3.2.4.1.1 "><p id="smn_api_51007__p2303739015551">Effect</p>
</td>
<td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.1.3.2.4.1.2 "><p id="smn_api_51007__p5408933915551">Statement effect</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.1.3.2.4.1.3 "><p id="smn_api_51007__p1916032815551">The effect can be <strong id="smn_api_51007__b84235270615257">Allow</strong> or <strong id="smn_api_51007__b8423527061530">Deny</strong>.</p>
</td>
</tr>
<tr id="smn_api_51007__row233616615551"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.1.3.2.4.1.1 "><p id="smn_api_51007__p923559515551">Principal</p>
<p id="smn_api_51007__p143555201842">NotPrincipal</p>
</td>
<td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.1.3.2.4.1.2 "><ul id="smn_api_51007__ul56995346416"><li id="smn_api_51007__li1450242817515"><strong id="smn_api_51007__b842352706123826">Principal</strong>: object to which the statement applies</li><li id="smn_api_51007__li112661649912"><strong id="smn_api_51007__b842352706123922">NotPrincipal</strong>: object to which the statement does not apply<p id="smn_api_51007__p716351816">The following two types of objects are supported:</p>
<ul id="smn_api_51007__ul64637189213"><li id="smn_api_51007__li086833423"><strong id="smn_api_51007__b842352706103025">CSP</strong>: one or more cloud users</li><li id="smn_api_51007__li134479815213"><strong id="smn_api_51007__b842352706103143">Service</strong>: one or more cloud services</li></ul>
</li></ul>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.1.3.2.4.1.3 "><p id="smn_api_51007__p44931755164956">Either the <strong id="smn_api_51007__b842352706185140">Principal</strong> or <strong id="smn_api_51007__b842352706185145">NotPrincipal</strong> element must be configured.</p>
<ul id="smn_api_51007__ul866085865315"><li id="smn_api_51007__li1660658155316">If you enter <strong id="smn_api_51007__b842352706185224">CSP</strong>, you must specify user information in the format <strong id="smn_api_51007__b842352706185337">urn:csp:iam::domainId:root</strong>. Obtain the domain ID of each user you specify.</li><li id="smn_api_51007__li8719329545">If you enter <strong id="smn_api_51007__b842352706185631">Service</strong>, you must specify the cloud service names in lower case.</li></ul>
</td>
</tr>
<tr id="smn_api_51007__row2239846215551"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.1.3.2.4.1.1 "><p id="smn_api_51007__p5316167715551">Action</p>
<p id="smn_api_51007__p586515126814">NotAction</p>
</td>
<td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.1.3.2.4.1.2 "><ul id="smn_api_51007__ul139511146291"><li id="smn_api_51007__li151704871018"><strong id="smn_api_51007__b84235270612425">Action</strong>: allowed statement action</li></ul>
<ul id="smn_api_51007__ul16815171817"><li id="smn_api_51007__li23421503919"><strong id="smn_api_51007__b84235270614829">NotAction</strong>: statement action not allowed<p id="smn_api_51007__p328452812317">You can use a wildcard character to configure a set of actions, for example, <strong id="smn_api_51007__b842352706104048_1">SMN:Update*</strong> and <strong id="smn_api_51007__b842352706104054_1">SMN:Delete*</strong>. If you only enter a wildcard character (*) in a statement, all supported actions are allowed.</p>
</li></ul>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.1.3.2.4.1.3 "><p id="smn_api_51007__p58838218165112">Either <strong id="smn_api_51007__b36039682201848">Action</strong> or <strong id="smn_api_51007__b55921686201848">NotAction</strong> must be configured.</p>
<p id="smn_api_51007__p2900090715551">The following actions are supported:</p>
<ul id="smn_api_51007__ul5968157515551"><li id="smn_api_51007__li26326515551">SMN:UpdateTopic</li><li id="smn_api_51007__li236938615551">SMN:DeleteTopic</li><li id="smn_api_51007__li2132447515551">SMN:QueryTopicDetail</li><li id="smn_api_51007__li5770254915551">SMN:ListTopicAttributes</li><li id="smn_api_51007__li4956089715551">SMN:UpdateTopicAttribute</li><li id="smn_api_51007__li4339489715551">SMN:DeleteTopicAttributes</li><li id="smn_api_51007__li5500975715551">SMN:DeleteTopicAttributeByName</li><li id="smn_api_51007__li2532576515551">SMN:ListSubscriptionsByTopic</li><li id="smn_api_51007__li2660530015551">SMN:Subscribe</li><li id="smn_api_51007__li754571215551">SMN:Unsubscribe</li><li id="smn_api_51007__li80255215551">SMN:Publish</li></ul>
</td>
</tr>
<tr id="smn_api_51007__row3341670315551"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.1.3.2.4.1.1 "><p id="smn_api_51007__p129519266014">Resource</p>
</td>
<td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.1.3.2.4.1.2 "><p id="smn_api_51007__p6969743152010">Specifies the topic the statement applies to.</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.1.3.2.4.1.3 "><p id="smn_api_51007__p14977997165224">Either <strong id="smn_api_51007__b842352706194447_5">Resource</strong> or <strong id="smn_api_51007__b84235270619452_5">NotResource</strong> must be configured.</p>
<p id="smn_api_51007__p6045376015551">You need to enter a topic URN.</p>
</td>
</tr>
<tr id="smn_api_51007__row1656112832015"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.1.3.2.4.1.1 "><p id="smn_api_51007__p127901121152015">NotResource</p>
</td>
<td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.1.3.2.4.1.2 "><p id="smn_api_51007__p1476113616208">Specifies the topic the statement does not apply to.</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.1.3.2.4.1.3 "><p id="smn_api_51007__p157913213206">Either <strong id="smn_api_51007__b1871704850">Resource</strong> or <strong id="smn_api_51007__b894311696">NotResource</strong> must be configured.</p>
<p id="smn_api_51007__p1779172182013">You need to enter a topic URN.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="smn_api_51007__li12005312185146">Example request<pre class="screen" id="smn_api_51007__screen39239870104645">PUT https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/<em id="smn_api_51007__i1152317331538">{topic_urn}</em>/attributes/access_policy</pre>
<pre class="screen" id="smn_api_51007__screen25531825192758">{
"value": "{
\"Version\": \"2016-09-07\",
\"Id\": \"__default_policy_ID\",
\"Statement\": [
{
\"Sid\": \"__user_pub_0\",
\"Effect\": \"Allow\",
\"Principal\": {
\"CSP\": [
\"urn:csp:iam::<em id="smn_api_51007__i3151101713356">{domainID}</em>:root\"
]
},
\"Action\": [\"SMN:Publish\",\"SMN:QueryTopicDetail\"],
\"Resource\": \"<em id="smn_api_51007__i828510178445">{topic_urn}</em>\"
},
{
\"Sid\": \"__service_pub_0\",
\"Effect\": \"Allow\",
\"Principal\": {
\"Service\": [\"obs\"]
},
\"Action\": [\"SMN:Publish\",\"SMN:QueryTopicDetail\"],
\"Resource\": \"<em id="smn_api_51007__i166181027133611">{topic_urn}</em>\"
}
]
}"
}</pre>
<div class="note" id="smn_api_51007__note1675815411963"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="smn_api_51007__p2284163934010">Replace <strong id="smn_api_51007__b842352706143820">{project_id}</strong>, <strong id="smn_api_51007__b842352706143825">{domainID}</strong>, and <strong id="smn_api_51007__b842352706143830">{topic_urn}</strong> with the actual values.</p>
<p id="smn_api_51007__p11310183185714"><strong id="smn_api_51007__b842352706143848">domainID</strong> indicates the user's account ID. To obtain it, log in to the SMN console, click <strong id="smn_api_51007__b842352706151632">My Credentials</strong> in the username drop-down list on the upper right.</p>
</div></div>
</li></ul>
</div>
<div class="section" id="smn_api_51007__section26561495"><h4 class="sectiontitle">Response</h4><ul id="smn_api_51007__ul42729680"><li id="smn_api_51007__li49022807">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="smn_api_51007__table38552084" frame="border" border="1" rules="all"><thead align="left"><tr id="smn_api_51007__row10058158"><th align="left" class="cellrowborder" valign="top" width="30.04%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="smn_api_51007__p9404449"><strong id="smn_api_51007__b146970903">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="31.380000000000003%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="smn_api_51007__p23562876"><strong id="smn_api_51007__b2034651300">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="38.58%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="smn_api_51007__p29544808"><strong id="smn_api_51007__b75353532">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="smn_api_51007__row33089041"><td class="cellrowborder" valign="top" width="30.04%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="smn_api_51007__p62966687">request_id</p>
</td>
<td class="cellrowborder" valign="top" width="31.380000000000003%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="smn_api_51007__p27997">String</p>
</td>
<td class="cellrowborder" valign="top" width="38.58%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="smn_api_51007__p2267763">Request ID, which is unique</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="smn_api_51007__li32325424">Example response<pre class="screen" id="smn_api_51007__screen4172555319825">{
"request_id":"6837531fd3f54550927b930180a706bf"
}</pre>
</li></ul>
</div>
<div class="section" id="smn_api_51007__section37726867"><h4 class="sectiontitle">Returned Value</h4><p id="smn_api_51007__p64140254">See <a href="smn_api_63002.html">Returned Value</a>.</p>
</div>
<div class="section" id="smn_api_51007__section73211020122511"><h4 class="sectiontitle">Error Codes</h4><p id="smn_api_51007__p9759142919265">See <a href="smn_api_64000.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="smn_api_51000.html">Topic Operations</a></div>
</div>
</div>