forked from docs/doc-exports
Zaoxu, Li
152a7d9381
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>
143 lines
11 KiB
HTML
143 lines
11 KiB
HTML
<a name="smn_api_51005"></a><a name="smn_api_51005"></a>
|
|
|
|
<h1 class="topictitle1">Querying Details of a Topic</h1>
|
|
<div id="body55361044"><div class="section" id="smn_api_51005__section64935954"><h4 class="sectiontitle">Description</h4><ul id="smn_api_51005__ul33304380203733"><li id="smn_api_51005__li51147505203733">API name<p id="smn_api_51005__p38624841203741"><a name="smn_api_51005__li51147505203733"></a><a name="li51147505203733"></a>QueryTopicDetail</p>
|
|
</li></ul>
|
|
<ul id="smn_api_51005__ul20998054203745"><li id="smn_api_51005__li46884910203750">Function<p id="smn_api_51005__p4186593495020"><a name="smn_api_51005__li46884910203750"></a><a name="li46884910203750"></a>Query the detailed information about a topic.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="smn_api_51005__section47552675"><h4 class="sectiontitle">URI</h4><ul id="smn_api_51005__ul30639779"><li id="smn_api_51005__li7322556">URI format<p id="smn_api_51005__p65903005"><a name="smn_api_51005__li7322556"></a><a name="li7322556"></a>GET /v2/{project_id}/notifications/topics/{topic_urn}</p>
|
|
</li></ul>
|
|
<ul id="smn_api_51005__ul56256135"><li id="smn_api_51005__li36543171">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="smn_api_51005__table60453091" frame="border" border="1" rules="all"><thead align="left"><tr id="smn_api_51005__row31471768"><th align="left" class="cellrowborder" valign="top" width="23.82238223822382%" id="mcps1.3.2.3.1.1.1.5.1.1"><p id="smn_api_51005__p66185246"><strong id="smn_api_51005__b842352706191030">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.942194219421943%" id="mcps1.3.2.3.1.1.1.5.1.2"><p id="smn_api_51005__p59404709"><strong id="smn_api_51005__b593421527191713">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.012101210121013%" id="mcps1.3.2.3.1.1.1.5.1.3"><p id="smn_api_51005__p47052116"><strong id="smn_api_51005__b84235270619112">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.223322332233224%" id="mcps1.3.2.3.1.1.1.5.1.4"><p id="smn_api_51005__p53125076"><strong id="smn_api_51005__b84235270619115">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="smn_api_51005__row57297510"><td class="cellrowborder" valign="top" width="23.82238223822382%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="smn_api_51005__p10586695">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.942194219421943%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="smn_api_51005__p52215961">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.012101210121013%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="smn_api_51005__p1634435">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.223322332233224%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="smn_api_51005__p61977638154952">Project ID</p>
|
|
<p id="smn_api_51005__p65280430">See <a href="smn_api_66000.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_51005__row9249362"><td class="cellrowborder" valign="top" width="23.82238223822382%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="smn_api_51005__p11000853">topic_urn</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.942194219421943%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="smn_api_51005__p18653909">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.012101210121013%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="smn_api_51005__p34571641">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.223322332233224%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="smn_api_51005__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>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="smn_api_51005__section25320898"><h4 class="sectiontitle">Request</h4><div class="p" id="smn_api_51005__p4773384111587">Example request<pre class="screen" id="smn_api_51005__screen24627917104551">GET https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:test_create_topic_v2</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="smn_api_51005__section26561495"><h4 class="sectiontitle">Response</h4><ul id="smn_api_51005__ul42729680"><li id="smn_api_51005__li49022807">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="smn_api_51005__table38552084" frame="border" border="1" rules="all"><thead align="left"><tr id="smn_api_51005__row10058158"><th align="left" class="cellrowborder" valign="top" width="25.81%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="smn_api_51005__p9404449"><strong id="smn_api_51005__b503992530">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.07%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="smn_api_51005__p23562876"><strong id="smn_api_51005__b688598694">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.12%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="smn_api_51005__p29544808"><strong id="smn_api_51005__b68172371">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="smn_api_51005__row33089041"><td class="cellrowborder" valign="top" width="25.81%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="smn_api_51005__p62966687">request_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.07%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="smn_api_51005__p27997">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.12%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="smn_api_51005__p2267763">Request ID, which is unique</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_51005__row42586845"><td class="cellrowborder" valign="top" width="25.81%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="smn_api_51005__p26982424">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.07%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="smn_api_51005__p38092711">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.12%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="smn_api_51005__p65610739">Name of the topic</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_51005__row48717564"><td class="cellrowborder" valign="top" width="25.81%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="smn_api_51005__p53808606">topic_urn</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.07%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="smn_api_51005__p63529816">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.12%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="smn_api_51005__p45641491">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_51005__row53759727"><td class="cellrowborder" valign="top" width="25.81%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="smn_api_51005__p59570626">display_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.07%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="smn_api_51005__p60491410">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.12%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="smn_api_51005__p57656838184157">Topic display name, which is presented as the name of the email sender in email messages</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_51005__row20888703"><td class="cellrowborder" valign="top" width="25.81%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="smn_api_51005__p14263389">push_policy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.07%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="smn_api_51005__p14483900">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.12%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="smn_api_51005__p32345284">Message pushing policy</p>
|
|
<p id="smn_api_51005__p10916523273"><strong id="smn_api_51005__b842352706928">0</strong> indicates that the message sending fails and the message is cached in the queue. <strong id="smn_api_51005__b8423527069213">1</strong> indicates that the failed message is discarded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_51005__row24500989"><td class="cellrowborder" valign="top" width="25.81%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="smn_api_51005__p38423121">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.07%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="smn_api_51005__p25265097">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.12%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="smn_api_51005__p33206990">Time when the topic was created</p>
|
|
<p id="smn_api_51005__p12947570279">The UTC time is in <em id="smn_api_51005__i3709181953211">YYYY-MM-DDTHH:MM:SSZ</em> format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_51005__row48704899"><td class="cellrowborder" valign="top" width="25.81%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="smn_api_51005__p52782726">update_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.07%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="smn_api_51005__p47542385">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.12%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="smn_api_51005__p25727981">Time when the topic was updated</p>
|
|
<p id="smn_api_51005__p15544215281">The UTC time is in <em id="smn_api_51005__i4623338325">YYYY-MM-DDTHH:MM:SSZ</em> format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_51005__row11373105010230"><td class="cellrowborder" valign="top" width="25.81%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="smn_api_51005__p9772191218526">enterprise_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.07%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="smn_api_51005__p27731512175217">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.12%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="smn_api_51005__p77737123525">Enterprise project ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="smn_api_51005__li32325424">Example response<pre class="screen" id="smn_api_51005__screen4172555319825">{
|
|
"update_time": "2016-08-01T02:16:38Z",
|
|
"push_policy": 0,
|
|
"create_time": "2016-08-01T02:16:38Z",
|
|
"name": "test_create_topic_v2",
|
|
"topic_urn": "urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:test_create_topic_v2",
|
|
"display_name": "test create topic v2",
|
|
"request_id": "6837531fd3f54550927b930180a706bf",
|
|
"enterprise_project_id" : "0"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="smn_api_51005__section37726867"><h4 class="sectiontitle">Returned Value</h4><p id="smn_api_51005__p64140254">See <a href="smn_api_63002.html">Returned Value</a>.</p>
|
|
</div>
|
|
<div class="section" id="smn_api_51005__section73211020122511"><h4 class="sectiontitle">Error Codes</h4><p id="smn_api_51005__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>
|
|
|