yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity

smn api 20250206 version: add information about mandatory Default protocol template.

Browse Source 
Reviewed-by: Daniel Kováč <a86700324@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: wanghuijuan738 <wanghuijuan738@huawei.com>
Co-committed-by: wanghuijuan738 <wanghuijuan738@huawei.com>
This commit is contained in:
Huijuan, Wang
2025-02-06 14:15:39 +00:00
committed by zuul
parent ce3b754e36
commit 48f6254910
14 changed files with 89 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
docs/smn/api-ref/ALL_META.TXT.json
View File

File diff suppressed because it is too large Load Diff

2
docs/smn/api-ref/CLASS.TXT.json
View File

@ -389,7 +389,7 @@
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"smn",
"title":"Sending an Application Message",
"title":"Sending an Application Message (Deprecated)",
"uri":"en-us_topic_0173593949.html",
"doc_type":"api",
"p_code":"38",

8
docs/smn/api-ref/en-us_topic_0036017316.html
View File

@ -1,8 +1,8 @@
<a name="en-us_topic_0036017316"></a><a name="en-us_topic_0036017316"></a>
<a name="EN-US_TOPIC_0036017316"></a><a name="EN-US_TOPIC_0036017316"></a>
<h1 class="topictitle1">API Usage Guidelines</h1>
<div id="body8662426"><p id="en-us_topic_0036017316__p105121142811">Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: <em id="en-us_topic_0036017316__en-us_topic_0020507759_i1385069210259">https://Endpoint/uri</em>. In the URL,<strong id="en-us_topic_0036017316__en-us_topic_0020507759_b5754736910259">uri</strong> indicates the resource path, that is, the API access path.</p>
<p id="en-us_topic_0036017316__p26499422919">Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by <strong id="en-us_topic_0036017316__en-us_topic_0020507759_b3082532510259">Application/json</strong>.</p>
<p id="en-us_topic_0036017316__p42011412113016">For details about how to use APIs, see <a href="https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328001.html?tag=API Documents" target="_blank" rel="noopener noreferrer">API Usage Guidelines</a>.</p>
<div id="body8662426"><p id="EN-US_TOPIC_0036017316__p105121142811">Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: <em id="EN-US_TOPIC_0036017316__en-us_topic_0020507759_i1385069210259">https://Endpoint/uri</em>. In the URL,<strong id="EN-US_TOPIC_0036017316__en-us_topic_0020507759_b5754736910259"> uri</strong> indicates the resource path, that is, the API access path.</p>
<p id="EN-US_TOPIC_0036017316__p26499422919">Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by <strong id="EN-US_TOPIC_0036017316__en-us_topic_0020507759_b3082532510259">Application/json</strong>.</p>
<p id="EN-US_TOPIC_0036017316__p42011412113016">For details about how to use APIs, see <a href="https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328001.html?tag=API Documents" target="_blank" rel="noopener noreferrer">API Usage Guidelines</a>.</p>
</div>

2
docs/smn/api-ref/en-us_topic_0173558607.html
View File

@ -14,7 +14,7 @@
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0173593944.html">Message Publishing</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0173593949.html">Sending an Application Message</a></strong><br>
<li class="ulchildlink"><strong><a href="en-us_topic_0173593949.html">Sending an Application Message (Deprecated)</a></strong><br>
</li>
</ul>
</div>

6
docs/smn/api-ref/en-us_topic_0173558608.html
View File

@ -2,15 +2,15 @@
<h1 class="topictitle1">Permissions Policies and Supported Actions</h1>
<div id="body8662426"><p id="EN-US_TOPIC_0173558608__en-us_topic_0173553747_en-us_topic_0171654733_p686912134917">This section describes fine-grained permissions management for your SMN resources. If your account does not need individual IAM users, you can skip over this section.</p>
<p id="EN-US_TOPIC_0173558608__a1f386e3a1c8c4ff381a0c29cc5cc9eaf">By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.</p>
<p id="EN-US_TOPIC_0173558608__a1f386e3a1c8c4ff381a0c29cc5cc9eaf">By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.</p>
<p id="EN-US_TOPIC_0173558608__a1b15943a939c41dbaeaa5cfa47275306">You can grant users permissions by using roles and policies. Roles: A type of coarse-grained authorization mechanism that defines service-level permissions based on user responsibilities. There are only a limited number of roles for granting permissions to users. Policies: A type of fine-grained authorization mechanism that defines permissions required to perform operations on specific cloud resources under certain conditions. This mechanism allows for more flexible policy-based authorization and secure access control. </p>
<div class="note" id="EN-US_TOPIC_0173558608__naa13368fc39a40e48410d65cabe45153"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0173558608__p2138846135118">Policy-based authorization is useful if you want to allow or deny the access to an API.</p>
</div></div>
<p id="EN-US_TOPIC_0173558608__ae91c77fbfe6247faa6db52521a7971ee">An account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query ECSs using an API, the user must have been granted permissions that allow the <strong id="EN-US_TOPIC_0173558608__b3379115018359">ecs:servers:list</strong> action.</p>
<div class="section" id="EN-US_TOPIC_0173558608__en-us_topic_0173553747_en-us_topic_0171654733_section677212217497"><h4 class="sectiontitle">Supported Actions</h4><p id="EN-US_TOPIC_0173558608__en-us_topic_0166806405_p52064552499">IAM provides system-defined policies that can be directly used. You can also create custom policies to supplement system-defined policies for more refined access control. Actions supported by policies are specific to APIs. Common concepts related to policies include:</p>
<ul id="EN-US_TOPIC_0173558608__u8d9007de06234085928a29ef0c6e58e0"><li id="EN-US_TOPIC_0173558608__li54855453342">Permissions: Statements in a policy that allow or deny certain operations.</li><li id="EN-US_TOPIC_0173558608__l04fdc83678e447f49aff210d2949b242">APIs: REST APIs that can be called by a user who has been granted specific permissions.</li><li id="EN-US_TOPIC_0173558608__en-us_topic_0166806405_li84486140474">Actions: Specific operations that are allowed or denied.</li><li id="EN-US_TOPIC_0173558608__li6132171512144">Related actions: Actions on which a specific action depends to take effect. When assigning permissions for the action to a user, you also need to assign permissions for the dependent actions.</li><li id="EN-US_TOPIC_0173558608__li61351453151518">IAM or enterprise projects: Type of projects for which an action will take effect. Policies that contain actions for both IAM and enterprise projects can be used and take effect for both IAM and Enterprise Management. Policies that only contain actions for IAM projects can be used and only take effect for IAM. Administrators can check whether an action supports IAM projects or enterprise projects in the action list. "√" indicates that the action supports the project and "×" indicates that the action does not support the project. </li></ul>
<ul id="EN-US_TOPIC_0173558608__u8d9007de06234085928a29ef0c6e58e0"><li id="EN-US_TOPIC_0173558608__li54855453342">Permissions: statements in a policy that allow or deny certain operations.</li><li id="EN-US_TOPIC_0173558608__l04fdc83678e447f49aff210d2949b242">APIs: REST APIs that can be called by a user who has been granted specific permissions.</li><li id="EN-US_TOPIC_0173558608__en-us_topic_0166806405_li84486140474">Actions: specific operations that are allowed or denied.</li><li id="EN-US_TOPIC_0173558608__li6132171512144">Related actions: actions on which a specific action depends to take effect. When assigning permissions for the action to a user, you also need to assign permissions for the dependent actions.</li><li id="EN-US_TOPIC_0173558608__li61351453151518">IAM or enterprise projects: type of projects for which an action will take effect. Policies that contain actions for both IAM and enterprise projects can be used and applied for both IAM and Enterprise Management. Policies that only contain actions for IAM projects can be used and only take effect for IAM. Administrators can check whether an action supports IAM projects or enterprise projects in the action list. "√" indicates that the action supports the project and "×" indicates that the action does not support the project. </li></ul>
<p id="EN-US_TOPIC_0173558608__en-us_topic_0173553747_en-us_topic_0171654733_p20870102118497">SMN supports the following actions that can be defined in custom policies:</p>
<ul id="EN-US_TOPIC_0173558608__ul199082554611"><li id="EN-US_TOPIC_0173558608__li29081553616"><a href="en-us_topic_0173593941.html">Topic Operations</a>, including actions supported by topic management APIs, such as APIs for creating, querying, updating, and deleting topics</li><li id="EN-US_TOPIC_0173558608__li947761017718"><a href="en-us_topic_0173593943.html">Template Operations</a>, including actions supported by message template management APIs, such as the APIs for creating, querying, updating, and deleting message templates</li><li id="EN-US_TOPIC_0173558608__li2923753773"><a href="en-us_topic_0173593946.html">Tag Operations</a>, including actions supported by TMS APIs, such as the APIs for querying resources, adding a resource tag, adding or deleting resource tags in batches, and deleting a resource a tag</li><li id="EN-US_TOPIC_0173558608__li7674137712"><a href="en-us_topic_0173593944.html">Message Publishing</a>, including actions supported by message publishing management APIs, such as the message publishing API</li><li id="EN-US_TOPIC_0173558608__li18494622789"><a href="en-us_topic_0173593949.html">Sending an Application Message</a>, including actions supported by direct application messaging management API, such as the API for sending an application message</li></ul>
<ul id="EN-US_TOPIC_0173558608__ul199082554611"><li id="EN-US_TOPIC_0173558608__li29081553616"><a href="en-us_topic_0173593941.html">Topic Operations</a>, including actions supported by topic management APIs, such as APIs for creating, querying, updating, and deleting topics</li><li id="EN-US_TOPIC_0173558608__li947761017718"><a href="en-us_topic_0173593943.html">Template Operations</a>, including actions supported by message template management APIs, such as the APIs for creating, querying, updating, and deleting message templates</li><li id="EN-US_TOPIC_0173558608__li2923753773"><a href="en-us_topic_0173593946.html">Tag Operations</a>, including actions supported by TMS APIs, such as the APIs for querying resources, adding a resource tag, adding or deleting resource tags in batches, and deleting a resource a tag</li><li id="EN-US_TOPIC_0173558608__li7674137712"><a href="en-us_topic_0173593944.html">Message Publishing</a>, including actions supported by message publishing management APIs, such as the message publishing API</li><li id="EN-US_TOPIC_0173558608__li18494622789"><a href="en-us_topic_0173593949.html">Sending an Application Message (Deprecated)</a>, including actions supported by direct application messaging management API, such as the API for sending an application message</li></ul>
</div>
</div>
<div>

2
docs/smn/api-ref/en-us_topic_0173593949.html
View File

@ -1,6 +1,6 @@
<a name="EN-US_TOPIC_0173593949"></a><a name="EN-US_TOPIC_0173593949"></a>
<h1 class="topictitle1">Sending an Application Message</h1>
<h1 class="topictitle1">Sending an Application Message (Deprecated)</h1>
<div id="body1559720516894">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0173593949__table411215513212" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0173593949__row31121855527"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.1.1.6.1.1"><p id="EN-US_TOPIC_0173593949__p129431911184814">Permission</p>
</th>

2
docs/smn/api-ref/smn_api_510002.html
View File

@ -41,7 +41,7 @@
</th>
<th align="left" class="cellrowborder" valign="top" width="23.762376237623762%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="smn_api_510002__en-us_topic_0118694332_p26427706"><strong>Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.415841584158414%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="smn_api_510002__en-us_topic_0118694332_p60269446"><strong id="smn_api_510002__b1363545675">Description</strong></p>
<th align="left" class="cellrowborder" valign="top" width="58.415841584158414%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="smn_api_510002__en-us_topic_0118694332_p60269446"><strong id="smn_api_510002__b1996938673">Description</strong></p>
</th>
</tr>
</thead>

13
docs/smn/api-ref/smn_api_53001.html
View File

@ -5,6 +5,7 @@
</li></ul>
<ul id="smn_api_53001__ul20998054203745"><li id="smn_api_53001__li46884910203750">Function<p id="smn_api_53001__p161662387455"><a name="smn_api_53001__li46884910203750"></a><a name="li46884910203750"></a>Create a message template for quick message sending to reduce the request data volume.</p>
<p id="smn_api_53001__p5295386410442">By default, a user can create a maximum of 100 message templates. However, in a high-concurrency scenario, which is rare, extra templates may be successfully created.</p>
<p id="smn_api_53001__p3742153519563">Message templates are identified by name, but you can create different templates with the same name as long as they are configured for different protocols. All template messages must include a <strong id="smn_api_53001__en-us_topic_0043394889_b1631511361618">Default</strong> template or they cannot be sent out. The <strong id="smn_api_53001__en-us_topic_0043394889_b14265659365">Default</strong> template is used anytime a template has not been configured for a given protocol, but as long as there is a template for the protocol, then any subscriber who selected that protocol when they subscribed will receive a message using the corresponding template.</p>
</li></ul>
</div>
<div class="section" id="smn_api_53001__section9256466193738"><h4 class="sectiontitle">URI</h4><ul id="smn_api_53001__ul11576320193738"><li id="smn_api_53001__li37078021193738">URI format<p id="smn_api_53001__p65266738193738"><a name="smn_api_53001__li37078021193738"></a><a name="li37078021193738"></a>POST /v2/{project_id}/notifications/message_template</p>
@ -36,13 +37,13 @@
</li></ul>
</div>
<div class="section" id="smn_api_53001__section62753823193738"><h4 class="sectiontitle">Request</h4><ul id="smn_api_53001__ul49894899193738"><li id="smn_api_53001__li46400914193738">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="smn_api_53001__table14955048193738" frame="border" border="1" rules="all"><thead align="left"><tr id="smn_api_53001__row8946017193738"><th align="left" class="cellrowborder" valign="top" width="25.629999999999995%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="smn_api_53001__p53538768193738"><strong id="smn_api_53001__b2074795357">Parameter</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="smn_api_53001__table14955048193738" frame="border" border="1" rules="all"><thead align="left"><tr id="smn_api_53001__row8946017193738"><th align="left" class="cellrowborder" valign="top" width="25.629999999999995%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="smn_api_53001__p53538768193738"><strong id="smn_api_53001__b937258235">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.41%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="smn_api_53001__p41672976193738"><strong id="smn_api_53001__b181195193337">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.560000000000002%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="smn_api_53001__p20067913193738"><strong id="smn_api_53001__b741693542">Type</strong></p>
<th align="left" class="cellrowborder" valign="top" width="21.560000000000002%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="smn_api_53001__p20067913193738"><strong id="smn_api_53001__b1866281422">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.4%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="smn_api_53001__p14888226193738"><strong id="smn_api_53001__b488416187">Description</strong></p>
<th align="left" class="cellrowborder" valign="top" width="30.4%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="smn_api_53001__p14888226193738"><strong id="smn_api_53001__b1149015143">Description</strong></p>
</th>
</tr>
</thead>
@ -90,11 +91,11 @@
</li></ul>
</div>
<div class="section" id="smn_api_53001__section2535551193738"><h4 class="sectiontitle">Response</h4><ul id="smn_api_53001__ul4053051193738"><li id="smn_api_53001__li36477466193738">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="smn_api_53001__table59861740193738" frame="border" border="1" rules="all"><thead align="left"><tr id="smn_api_53001__row37209510193738"><th align="left" class="cellrowborder" valign="top" width="34.09340934093409%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="smn_api_53001__p61180371193738"><strong id="smn_api_53001__b1900856937">Parameter</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="smn_api_53001__table59861740193738" frame="border" border="1" rules="all"><thead align="left"><tr id="smn_api_53001__row37209510193738"><th align="left" class="cellrowborder" valign="top" width="34.09340934093409%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="smn_api_53001__p61180371193738"><strong id="smn_api_53001__b2116343234">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="29.56295629562956%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="smn_api_53001__p56663008193738"><strong id="smn_api_53001__b1881007783">Type</strong></p>
<th align="left" class="cellrowborder" valign="top" width="29.56295629562956%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="smn_api_53001__p56663008193738"><strong id="smn_api_53001__b2112444544">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="36.343634363436344%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="smn_api_53001__p26300917193738"><strong id="smn_api_53001__b1629751159">Description</strong></p>
<th align="left" class="cellrowborder" valign="top" width="36.343634363436344%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="smn_api_53001__p26300917193738"><strong id="smn_api_53001__b240034717">Description</strong></p>
</th>
</tr>
</thead>

14
docs/smn/api-ref/smn_api_54003.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Publishing Messages Using a Template</h1>
<div id="body1471602451370"><div class="section" id="smn_api_54003__section52611782195031"><h4 class="sectiontitle">Description</h4><ul id="smn_api_54003__ul33304380203733"><li id="smn_api_54003__li51147505203733">API name<p id="smn_api_54003__p38624841203741"><a name="smn_api_54003__li51147505203733"></a><a name="li51147505203733"></a>Publish</p>
</li></ul>
<ul id="smn_api_54003__ul20998054203745"><li id="smn_api_54003__li46884910203750">Function<p id="smn_api_54003__p4717288173954"><a name="smn_api_54003__li46884910203750"></a><a name="li46884910203750"></a>Use the message template to publish a message to a topic. After the message ID is returned, the message has been saved and is to be pushed to the subscribers of the topic. This API allows you to send messages to different types of subscribers using different template protocols with the same name.</p>
<ul id="smn_api_54003__ul20998054203745"><li id="smn_api_54003__li46884910203750">Function<p id="smn_api_54003__p4717288173954"><a name="smn_api_54003__li46884910203750"></a><a name="li46884910203750"></a>Use the message template to publish a message to a topic. After the message ID is returned, the message has been saved and is to be pushed to the subscribers of the topic. This API allows you to send messages to different types of subscribers using the same template name but different protocols.</p>
</li></ul>
</div>
<div class="section" id="smn_api_54003__section34827906195031"><h4 class="sectiontitle">URI</h4><ul id="smn_api_54003__ul2488120195031"><li id="smn_api_54003__li22393088195031">URI format<p class="tabletext" id="smn_api_54003__p211204195031"><a name="smn_api_54003__li22393088195031"></a><a name="li22393088195031"></a>POST /v2/{project_id}/notifications/topics/{topic_urn}/publish</p>
@ -44,13 +44,13 @@
</li></ul>
</div>
<div class="section" id="smn_api_54003__section45105086195031"><h4 class="sectiontitle">Request</h4><ul id="smn_api_54003__ul29633365195031"><li id="smn_api_54003__li65373700195031">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="smn_api_54003__table51492393195031" frame="border" border="1" rules="all"><thead align="left"><tr id="smn_api_54003__row30761845195031"><th align="left" class="cellrowborder" valign="top" width="23.627637236276374%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="smn_api_54003__p8681487195031"><strong id="smn_api_54003__b1180792741">Parameter</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="smn_api_54003__table51492393195031" frame="border" border="1" rules="all"><thead align="left"><tr id="smn_api_54003__row30761845195031"><th align="left" class="cellrowborder" valign="top" width="23.627637236276374%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="smn_api_54003__p8681487195031"><strong id="smn_api_54003__b811998472">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.65793420657934%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="smn_api_54003__p32111829195031"><strong id="smn_api_54003__b2083279393642">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.42785721427857%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="smn_api_54003__p50921393195031"><strong id="smn_api_54003__b2101424426">Type</strong></p>
<th align="left" class="cellrowborder" valign="top" width="21.42785721427857%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="smn_api_54003__p50921393195031"><strong id="smn_api_54003__b1616802918">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="34.28657134286571%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="smn_api_54003__p30992136195031"><strong id="smn_api_54003__b66195391">Description</strong></p>
<th align="left" class="cellrowborder" valign="top" width="34.28657134286571%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="smn_api_54003__p30992136195031"><strong id="smn_api_54003__b365367986">Description</strong></p>
</th>
</tr>
</thead>
@ -116,11 +116,11 @@
</li></ul>
</div>
<div class="section" id="smn_api_54003__section12227696195031"><h4 class="sectiontitle">Response</h4><ul id="smn_api_54003__ul50919299195031"><li id="smn_api_54003__li55620508195031">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="smn_api_54003__table30822526195031" frame="border" border="1" rules="all"><thead align="left"><tr id="smn_api_54003__row47162257195031"><th align="left" class="cellrowborder" valign="top" width="37.70622937706229%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="smn_api_54003__p62046506195031"><strong id="smn_api_54003__b2060580873">Parameter</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="smn_api_54003__table30822526195031" frame="border" border="1" rules="all"><thead align="left"><tr id="smn_api_54003__row47162257195031"><th align="left" class="cellrowborder" valign="top" width="37.70622937706229%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="smn_api_54003__p62046506195031"><strong id="smn_api_54003__b1933602262">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.257274272572747%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="smn_api_54003__p59711095195031"><strong id="smn_api_54003__b90623954">Type</strong></p>
<th align="left" class="cellrowborder" valign="top" width="27.257274272572747%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="smn_api_54003__p59711095195031"><strong id="smn_api_54003__b453848213">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="35.03649635036496%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="smn_api_54003__p4760545195031"><strong id="smn_api_54003__b2045305843">Description</strong></p>
<th align="left" class="cellrowborder" valign="top" width="35.03649635036496%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="smn_api_54003__p4760545195031"><strong id="smn_api_54003__b1865083304">Description</strong></p>
</th>
</tr>
</thead>

10
docs/smn/api-ref/smn_api_56002.html
View File

@ -50,7 +50,7 @@
</td>
<td class="cellrowborder" valign="top" width="33.78337833783379%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="smn_api_56002__p176341254201810">Resource ID</p>
<p id="smn_api_56002__p57491711103514">Obtain a resource ID:</p>
<ul id="smn_api_56002__ul969372310137"><li id="smn_api_56002__li969342316131">Add <strong id="smn_api_56002__b1745003620">X-SMN-RESOURCEID-TYPE=name</strong> in the request header and set the resource ID to the topic name.</li><li id="smn_api_56002__li1669312233134">Call the <strong id="smn_api_56002__b84235270694340">GetResourceInstances</strong> API to obtain the resource ID.</li></ul>
<ul id="smn_api_56002__ul969372310137"><li id="smn_api_56002__li969342316131">Add <strong id="smn_api_56002__b269934385">X-SMN-RESOURCEID-TYPE=name</strong> in the request header and set the resource ID to the topic name.</li><li id="smn_api_56002__li1669312233134">Call the <strong id="smn_api_56002__b84235270694340">GetResourceInstances</strong> API to obtain the resource ID.</li></ul>
</td>
</tr>
</tbody>
@ -59,13 +59,13 @@
</li></ul>
</div>
<div class="section" id="smn_api_56002__section2197105410186"><h4 class="sectiontitle">Request</h4><ul id="smn_api_56002__ul18634105451811"><li id="smn_api_56002__li1634125441812">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="smn_api_56002__table4213165415189" frame="border" border="1" rules="all"><thead align="left"><tr id="smn_api_56002__row16634145491814"><th align="left" class="cellrowborder" valign="top" width="16.88%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="smn_api_56002__p463435412187"><strong id="smn_api_56002__b2035164958">Parameter</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="smn_api_56002__table4213165415189" frame="border" border="1" rules="all"><thead align="left"><tr id="smn_api_56002__row16634145491814"><th align="left" class="cellrowborder" valign="top" width="16.88%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="smn_api_56002__p463435412187"><strong id="smn_api_56002__b753514041">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.68%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="smn_api_56002__p16634054131814"><strong id="smn_api_56002__b1727693177">Mandatory</strong></p>
<th align="left" class="cellrowborder" valign="top" width="24.68%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="smn_api_56002__p16634054131814"><strong id="smn_api_56002__b617312128">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.78%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="smn_api_56002__p9634155414185"><strong id="smn_api_56002__b1885752780">Type</strong></p>
<th align="left" class="cellrowborder" valign="top" width="20.78%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="smn_api_56002__p9634155414185"><strong id="smn_api_56002__b1361052604">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="37.66%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="smn_api_56002__p2063413547181"><strong id="smn_api_56002__b1902893602">Description</strong></p>
<th align="left" class="cellrowborder" valign="top" width="37.66%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="smn_api_56002__p2063413547181"><strong id="smn_api_56002__b748258684">Description</strong></p>
</th>
</tr>
</thead>

2
docs/smn/api-ref/smn_api_56003.html
View File

@ -47,7 +47,7 @@
</td>
<td class="cellrowborder" valign="top" width="32.87671232876712%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="smn_api_56003__p176341254201810">Resource ID</p>
<p id="smn_api_56003__p57491711103514">Obtain a resource ID:</p>
<ul id="smn_api_56003__ul111761720155610"><li id="smn_api_56003__smn_api_56002_li969342316131">Add <strong id="smn_api_56003__smn_api_56002_b1745003620">X-SMN-RESOURCEID-TYPE=name</strong> in the request header and set the resource ID to the topic name.</li><li id="smn_api_56003__smn_api_56002_li1669312233134">Call the <strong id="smn_api_56003__smn_api_56002_b84235270694340">GetResourceInstances</strong> API to obtain the resource ID.</li></ul>
<ul id="smn_api_56003__ul111761720155610"><li id="smn_api_56003__smn_api_56002_li969342316131">Add <strong id="smn_api_56003__smn_api_56002_b269934385">X-SMN-RESOURCEID-TYPE=name</strong> in the request header and set the resource ID to the topic name.</li><li id="smn_api_56003__smn_api_56002_li1669312233134">Call the <strong id="smn_api_56003__smn_api_56002_b84235270694340">GetResourceInstances</strong> API to obtain the resource ID.</li></ul>
</td>
</tr>
</tbody>

2
docs/smn/api-ref/smn_api_56004.html
View File

@ -47,7 +47,7 @@
</td>
<td class="cellrowborder" valign="top" width="29.17%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="smn_api_56004__p176341254201810">Resource ID</p>
<p id="smn_api_56004__p57491711103514">Obtain a resource ID:</p>
<ul id="smn_api_56004__ul111761720155610"><li id="smn_api_56004__smn_api_56002_li969342316131">Add <strong id="smn_api_56004__smn_api_56002_b1745003620">X-SMN-RESOURCEID-TYPE=name</strong> in the request header and set the resource ID to the topic name.</li><li id="smn_api_56004__smn_api_56002_li1669312233134">Call the <strong id="smn_api_56004__smn_api_56002_b84235270694340">GetResourceInstances</strong> API to obtain the resource ID.</li></ul>
<ul id="smn_api_56004__ul111761720155610"><li id="smn_api_56004__smn_api_56002_li969342316131">Add <strong id="smn_api_56004__smn_api_56002_b269934385">X-SMN-RESOURCEID-TYPE=name</strong> in the request header and set the resource ID to the topic name.</li><li id="smn_api_56004__smn_api_56002_li1669312233134">Call the <strong id="smn_api_56004__smn_api_56002_b84235270694340">GetResourceInstances</strong> API to obtain the resource ID.</li></ul>
</td>
</tr>
</tbody>

2
docs/smn/api-ref/smn_api_56005.html
View File

@ -46,7 +46,7 @@
</td>
<td class="cellrowborder" valign="top" width="26.39%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="smn_api_56005__p176341254201810">Resource ID</p>
<p id="smn_api_56005__p57491711103514">Obtain a resource ID:</p>
<ul id="smn_api_56005__ul111761720155610"><li id="smn_api_56005__smn_api_56002_li969342316131">Add <strong id="smn_api_56005__smn_api_56002_b1745003620">X-SMN-RESOURCEID-TYPE=name</strong> in the request header and set the resource ID to the topic name.</li><li id="smn_api_56005__smn_api_56002_li1669312233134">Call the <strong id="smn_api_56005__smn_api_56002_b84235270694340">GetResourceInstances</strong> API to obtain the resource ID.</li></ul>
<ul id="smn_api_56005__ul111761720155610"><li id="smn_api_56005__smn_api_56002_li969342316131">Add <strong id="smn_api_56005__smn_api_56002_b269934385">X-SMN-RESOURCEID-TYPE=name</strong> in the request header and set the resource ID to the topic name.</li><li id="smn_api_56005__smn_api_56002_li1669312233134">Call the <strong id="smn_api_56005__smn_api_56002_b84235270694340">GetResourceInstances</strong> API to obtain the resource ID.</li></ul>
</td>
</tr>
</tbody>

2
docs/smn/api-ref/smn_api_66000.html
View File

@ -5,7 +5,7 @@
<ul id="smn_api_66000__en-us_topic_0121673684_ul2770123611111"><li id="smn_api_66000__en-us_topic_0121673684_li157701436141116"><a href="#smn_api_66000__en-us_topic_0121673684_section86806471133">Obtain the Project ID by Calling an API</a></li><li id="smn_api_66000__en-us_topic_0121673684_li07701836121118"><a href="#smn_api_66000__en-us_topic_0121673684_section32975495318">Obtain the Project ID from the Console</a></li></ul>
</div>
<div class="section" id="smn_api_66000__en-us_topic_0121673684_section86806471133"><a name="smn_api_66000__en-us_topic_0121673684_section86806471133"></a><a name="en-us_topic_0121673684_section86806471133"></a><h4 class="sectiontitle">Obtain the Project ID by Calling an API</h4><p id="smn_api_66000__en-us_topic_0121673684_p31183326524">You can obtain the project ID by calling the IAM API used to query project information based on the specified criteria.</p>
<p id="smn_api_66000__en-us_topic_0121673684_p857314915139">The API used to obtain a project ID is GET https://{Endpoint}/v3/projects. {Endpoint} is the IAM endpoint and can be obtained from <a href="https://docs.otc.t-systems.com/additional/endpoints.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>. </p>
<p id="smn_api_66000__en-us_topic_0121673684_p857314915139">The API used to obtain a project ID is GET https://{Endpoint}/v3/projects. {Endpoint} is the IAM endpoint and can be obtained from <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>. </p>
<p id="smn_api_66000__en-us_topic_0121673684_p3770181514218">The following is an example response. The value of <strong id="smn_api_66000__en-us_topic_0121673684_b842352706123544">id</strong> is the project ID.</p>
<pre class="screen" id="smn_api_66000__en-us_topic_0121673684_screen14199113161316">{
"projects": [