forked from docs/doc-exports
guoyanyan
feae604f17
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: guoyanyan <guoyanyan3@huawei.com> Co-committed-by: guoyanyan <guoyanyan3@huawei.com>
434 lines
17 KiB
JSON
434 lines
17 KiB
JSON
[
|
|
{
|
|
"desc":"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 ",
|
|
"product_code":"smn",
|
|
"title":"API Usage Guidelines",
|
|
"uri":"en-us_topic_0036017316.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"1"
|
|
},
|
|
{
|
|
"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":"APIs",
|
|
"uri":"smn_api_50000.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"2"
|
|
},
|
|
{
|
|
"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":"Topic Operations",
|
|
"uri":"smn_api_51000.html",
|
|
"doc_type":"api",
|
|
"p_code":"2",
|
|
"code":"3"
|
|
},
|
|
{
|
|
"desc":"API nameCreateTopicCreateTopicFunctionCreate a topic. Each user can create 3000 topics at most. In the high-concurrent scenario, a user may create a few topics more than ",
|
|
"product_code":"smn",
|
|
"title":"Creating a Topic",
|
|
"uri":"smn_api_51001.html",
|
|
"doc_type":"api",
|
|
"p_code":"3",
|
|
"code":"4"
|
|
},
|
|
{
|
|
"desc":"API nameUpdateTopicUpdateTopicFunctionUpdate the topic display name.Update the topic display name.URI formatPUT /v2/{project_id}/notifications/topics/{topic_urn}PUT /v2/{",
|
|
"product_code":"smn",
|
|
"title":"Modifying a Topic",
|
|
"uri":"smn_api_51002.html",
|
|
"doc_type":"api",
|
|
"p_code":"3",
|
|
"code":"5"
|
|
},
|
|
{
|
|
"desc":"API nameDeleteTopicDeleteTopicFunctionDelete a topic and its subscribers. If a topic is deleted, a pending message will fail to deliver to the topic subscribers.Delete a ",
|
|
"product_code":"smn",
|
|
"title":"Deleting a Topic",
|
|
"uri":"smn_api_51003.html",
|
|
"doc_type":"api",
|
|
"p_code":"3",
|
|
"code":"6"
|
|
},
|
|
{
|
|
"desc":"API nameListTopicsListTopicsFunctionQuery the topic list by page. The list is sorted by the topic creation time in descending order. If no topic has been created, an empt",
|
|
"product_code":"smn",
|
|
"title":"Querying Topics",
|
|
"uri":"smn_api_51004.html",
|
|
"doc_type":"api",
|
|
"p_code":"3",
|
|
"code":"7"
|
|
},
|
|
{
|
|
"desc":"API nameQueryTopicDetailQueryTopicDetailFunctionQuery the detailed information about a topic.Query the detailed information about a topic.URI formatGET /v2/{project_id}/n",
|
|
"product_code":"smn",
|
|
"title":"Querying Topic Details",
|
|
"uri":"smn_api_51005.html",
|
|
"doc_type":"api",
|
|
"p_code":"3",
|
|
"code":"8"
|
|
},
|
|
{
|
|
"desc":"API nameListTopicAttributesListTopicAttributesFunctionQuery the topic attribute information.Query the topic attribute information.URI formatGET /v2/{project_id}/notificat",
|
|
"product_code":"smn",
|
|
"title":"Querying Topic Attributes",
|
|
"uri":"smn_api_51006.html",
|
|
"doc_type":"api",
|
|
"p_code":"3",
|
|
"code":"9"
|
|
},
|
|
{
|
|
"desc":"API nameUpdateTopicAttributeUpdateTopicAttributeFunctionModify the topic attributes.Modify the topic attributes.URI formatPUT /v2/{project_id}/notifications/topics/{topic",
|
|
"product_code":"smn",
|
|
"title":"Modifying Topic Attributes",
|
|
"uri":"smn_api_51007.html",
|
|
"doc_type":"api",
|
|
"p_code":"3",
|
|
"code":"10"
|
|
},
|
|
{
|
|
"desc":"API nameDeleteTopicAttributeByNameDeleteTopicAttributeByNameFunctionDelete a specified topic attribute.Delete a specified topic attribute.URI formatDELETE /v2/{project_id",
|
|
"product_code":"smn",
|
|
"title":"Deleting a Specified Topic Attribute",
|
|
"uri":"smn_api_51008.html",
|
|
"doc_type":"api",
|
|
"p_code":"3",
|
|
"code":"11"
|
|
},
|
|
{
|
|
"desc":"API nameDeleteTopicAttributesDeleteTopicAttributesFunctionDelete all topic attributes.Delete all topic attributes.URI formatDELETE /v2/{project_id}/notifications/topics/{",
|
|
"product_code":"smn",
|
|
"title":"Deleting All Topic Attributes",
|
|
"uri":"smn_api_51009.html",
|
|
"doc_type":"api",
|
|
"p_code":"3",
|
|
"code":"12"
|
|
},
|
|
{
|
|
"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":"Subscription Operations",
|
|
"uri":"smn_api_52000.html",
|
|
"doc_type":"api",
|
|
"p_code":"2",
|
|
"code":"13"
|
|
},
|
|
{
|
|
"desc":"API nameListSubscriptionsListSubscriptionsFunctionQuery the list of all subscriptions by page. The list is sorted by the subscription adding time in ascending order. If n",
|
|
"product_code":"smn",
|
|
"title":"Querying Subscriptions",
|
|
"uri":"smn_api_52001.html",
|
|
"doc_type":"api",
|
|
"p_code":"13",
|
|
"code":"14"
|
|
},
|
|
{
|
|
"desc":"API nameListSubscriptionsByTopicListSubscriptionsByTopicFunctionQuery the list of subscriptions of a specified topic by page. The list is sorted by the subscription addin",
|
|
"product_code":"smn",
|
|
"title":"Querying Subscriptions of a Specified Topic",
|
|
"uri":"smn_api_52002.html",
|
|
"doc_type":"api",
|
|
"p_code":"13",
|
|
"code":"15"
|
|
},
|
|
{
|
|
"desc":"API nameSubscribeSubscribeFunctionAdd a subscription to a specified topic. If the status of the subscription is unconfirmed, a confirmation message is sent to the subscri",
|
|
"product_code":"smn",
|
|
"title":"Adding a Subscription",
|
|
"uri":"smn_api_52003.html",
|
|
"doc_type":"api",
|
|
"p_code":"13",
|
|
"code":"16"
|
|
},
|
|
{
|
|
"desc":"API nameUnsubscribeUnsubscribeFunctionDelete a specified subscription.Delete a specified subscription.URI formatDELETE /v2/{project_id}/notifications/subscriptions/{subsc",
|
|
"product_code":"smn",
|
|
"title":"Deleting a Subscription",
|
|
"uri":"smn_api_52004.html",
|
|
"doc_type":"api",
|
|
"p_code":"13",
|
|
"code":"17"
|
|
},
|
|
{
|
|
"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":"Template Operation",
|
|
"uri":"smn_api_53000.html",
|
|
"doc_type":"api",
|
|
"p_code":"2",
|
|
"code":"18"
|
|
},
|
|
{
|
|
"desc":"API nameCreateMessageTemplateCreateMessageTemplateFunctionCreate a message template for quick message sending to reduce the request data volume.By default, a user can cre",
|
|
"product_code":"smn",
|
|
"title":"Creating a Message Template",
|
|
"uri":"smn_api_53001.html",
|
|
"doc_type":"api",
|
|
"p_code":"18",
|
|
"code":"19"
|
|
},
|
|
{
|
|
"desc":"API nameUpdateMessageTemplateUpdateMessageTemplateFunctionModify the message template content.Modify the message template content.URI formatPUT /v2/{project_id}/notificat",
|
|
"product_code":"smn",
|
|
"title":"Modifying a Message Template",
|
|
"uri":"smn_api_53002.html",
|
|
"doc_type":"api",
|
|
"p_code":"18",
|
|
"code":"20"
|
|
},
|
|
{
|
|
"desc":"API nameDeleteMessageTemplateDeleteMessageTemplateFunctionDelete a message template. After you delete the template, you cannot use it to publish messages any more.Delete ",
|
|
"product_code":"smn",
|
|
"title":"Deleting a Message Template",
|
|
"uri":"smn_api_53003.html",
|
|
"doc_type":"api",
|
|
"p_code":"18",
|
|
"code":"21"
|
|
},
|
|
{
|
|
"desc":"API nameListMessageTemplatesListMessageTemplatesFunctionQuery the template list by page. The list is sorted by the template creation time in ascending order. If no templa",
|
|
"product_code":"smn",
|
|
"title":"Querying Message Templates",
|
|
"uri":"smn_api_53004.html",
|
|
"doc_type":"api",
|
|
"p_code":"18",
|
|
"code":"22"
|
|
},
|
|
{
|
|
"desc":"API nameQueryMessageTemplateDetailQueryMessageTemplateDetailFunctionQuery the template details, including the template content.Query the template details, including the t",
|
|
"product_code":"smn",
|
|
"title":"Querying the Message Template Details",
|
|
"uri":"smn_api_53005.html",
|
|
"doc_type":"api",
|
|
"p_code":"18",
|
|
"code":"23"
|
|
},
|
|
{
|
|
"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":"Message Publishing",
|
|
"uri":"smn_api_54000.html",
|
|
"doc_type":"api",
|
|
"p_code":"2",
|
|
"code":"24"
|
|
},
|
|
{
|
|
"desc":"API namePublishPublishFunctionPublish messages in the text format to a topic. After the message ID is returned, the message has been saved and is to be pushed to the subs",
|
|
"product_code":"smn",
|
|
"title":"Publishing Messages in the Text Format",
|
|
"uri":"smn_api_54001.html",
|
|
"doc_type":"api",
|
|
"p_code":"24",
|
|
"code":"25"
|
|
},
|
|
{
|
|
"desc":"API namePublishPublishFunctionUse the message structure to publish a message to the topic. After the message ID is returned, the message has been saved and is to be pushe",
|
|
"product_code":"smn",
|
|
"title":"Publishing Messages Using a Message Structure",
|
|
"uri":"smn_api_54002.html",
|
|
"doc_type":"api",
|
|
"p_code":"24",
|
|
"code":"26"
|
|
},
|
|
{
|
|
"desc":"API namePublishPublishFunctionUse 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 t",
|
|
"product_code":"smn",
|
|
"title":"Publishing Messages Using a Template",
|
|
"uri":"smn_api_54003.html",
|
|
"doc_type":"api",
|
|
"p_code":"24",
|
|
"code":"27"
|
|
},
|
|
{
|
|
"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":"SMS Message Operations",
|
|
"uri":"smn_api_55000.html",
|
|
"doc_type":"api",
|
|
"p_code":"2",
|
|
"code":"28"
|
|
},
|
|
{
|
|
"desc":"Direct SMS messaging is not available to new users. If you want to use these APIs, go to Cloud Communications > Message&SMS.API nameSmsPublishSmsPublishFunctionSend a tra",
|
|
"product_code":"smn",
|
|
"title":"Sending a Transactional SMS Message to a Phone Number",
|
|
"uri":"smn_api_55001.html",
|
|
"doc_type":"api",
|
|
"p_code":"28",
|
|
"code":"29"
|
|
},
|
|
{
|
|
"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":"Resource Tag Operations",
|
|
"uri":"smn_api_56000.html",
|
|
"doc_type":"api",
|
|
"p_code":"2",
|
|
"code":"30"
|
|
},
|
|
{
|
|
"desc":"API nameGetResourceInstancesGetResourceInstancesFunctionQuery SMN resources by tag.Query SMN resources by tag.URI formatPOST /v2/{project_id}/{resource_type}/resource_ins",
|
|
"product_code":"smn",
|
|
"title":"Querying Resources by Tag",
|
|
"uri":"smn_api_56001.html",
|
|
"doc_type":"api",
|
|
"p_code":"30",
|
|
"code":"31"
|
|
},
|
|
{
|
|
"desc":"API nameBatchCreateOrDeleteResourceTagsBatchCreateOrDeleteResourceTagsFunctionAdd or delete tags for a specified resource in batches.You can add a maximum of 10 tags to a",
|
|
"product_code":"smn",
|
|
"title":"Adding or Deleting Resource Tags in Batches",
|
|
"uri":"smn_api_56002.html",
|
|
"doc_type":"api",
|
|
"p_code":"30",
|
|
"code":"32"
|
|
},
|
|
{
|
|
"desc":"API nameCreateResourceTagCreateResourceTagFunctionYou can add a maximum of 10 tags to a resource.The API is idempotent. If a to-be-created tag has the same key as an exis",
|
|
"product_code":"smn",
|
|
"title":"Adding a Resource Tag",
|
|
"uri":"smn_api_56003.html",
|
|
"doc_type":"api",
|
|
"p_code":"30",
|
|
"code":"33"
|
|
},
|
|
{
|
|
"desc":"API nameDeleteResourceTagDeleteResourceTagFunctionThe API is idempotent. When deleting a tag, the system does not check its character set. The tag key cannot be left blan",
|
|
"product_code":"smn",
|
|
"title":"Deleting a Resource Tag",
|
|
"uri":"smn_api_56004.html",
|
|
"doc_type":"api",
|
|
"p_code":"30",
|
|
"code":"34"
|
|
},
|
|
{
|
|
"desc":"API nameListResourceTagsListResourceTagsFunctionQuery tags of a specified resource.Query tags of a specified resource.URI formatGET /v2/{project_id}/{resource_type}/{reso",
|
|
"product_code":"smn",
|
|
"title":"Querying Resource Tags",
|
|
"uri":"smn_api_56005.html",
|
|
"doc_type":"api",
|
|
"p_code":"30",
|
|
"code":"35"
|
|
},
|
|
{
|
|
"desc":"API nameGetProjectTagsGetProjectTagsFunctionQuery all tags of a resource type in a specified project.Query all tags of a resource type in a specified project.URI formatGE",
|
|
"product_code":"smn",
|
|
"title":"Querying Tags in a Specified Project",
|
|
"uri":"smn_api_56006.html",
|
|
"doc_type":"api",
|
|
"p_code":"30",
|
|
"code":"36"
|
|
},
|
|
{
|
|
"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":"Version Querying",
|
|
"uri":"smn_api_510000.html",
|
|
"doc_type":"api",
|
|
"p_code":"2",
|
|
"code":"37"
|
|
},
|
|
{
|
|
"desc":"API nameQueryApiSupportVersionsQueryApiSupportVersionsFunctionList all SMN API versions.List all SMN API versions.URI formatGET /GET /Request exampleGET https://{SMN_Endp",
|
|
"product_code":"smn",
|
|
"title":"Listing All SMN API Versions",
|
|
"uri":"smn_api_510001.html",
|
|
"doc_type":"api",
|
|
"p_code":"37",
|
|
"code":"38"
|
|
},
|
|
{
|
|
"desc":"API nameQueryV2ApiInfoQueryV2ApiInfoFunctionQuery the SMN API v2 version information.Query the SMN API v2 version information.URI formatGET /{api_version}GET /{api_versio",
|
|
"product_code":"smn",
|
|
"title":"Querying the SMN API v2 Version",
|
|
"uri":"smn_api_510002.html",
|
|
"doc_type":"api",
|
|
"p_code":"37",
|
|
"code":"39"
|
|
},
|
|
{
|
|
"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":"Public Parameters",
|
|
"uri":"smn_api_60000.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"40"
|
|
},
|
|
{
|
|
"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":"General Request Return Code",
|
|
"uri":"smn_api_63000.html",
|
|
"doc_type":"api",
|
|
"p_code":"40",
|
|
"code":"41"
|
|
},
|
|
{
|
|
"desc":"Parameter descriptionParameterTypeDescriptionrequest_idStringRequest IDcodeStringSee section Error Code.messageStringSee section Error Code.Example{\n \"request_id\": \"aa",
|
|
"product_code":"smn",
|
|
"title":"Exception Response",
|
|
"uri":"smn_api_63001.html",
|
|
"doc_type":"api",
|
|
"p_code":"41",
|
|
"code":"42"
|
|
},
|
|
{
|
|
"desc":"NormalReturned ValueDescription200The task is submitted successfully.201Resource creation succeeds.AbnormalReturned ValueDescription400 Bad RequestIncorrect request param",
|
|
"product_code":"smn",
|
|
"title":"Returned Value",
|
|
"uri":"smn_api_63002.html",
|
|
"doc_type":"api",
|
|
"p_code":"41",
|
|
"code":"43"
|
|
},
|
|
{
|
|
"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":"Error Code",
|
|
"uri":"smn_api_64000.html",
|
|
"doc_type":"api",
|
|
"p_code":"40",
|
|
"code":"44"
|
|
},
|
|
{
|
|
"desc":"A project ID needs to be specified in the URIs of some APIs. Therefore, you need to obtain the project ID before calling APIs. The following procedure describes how to ob",
|
|
"product_code":"smn",
|
|
"title":"Obtaining a Project ID",
|
|
"uri":"smn_api_66000.html",
|
|
"doc_type":"api",
|
|
"p_code":"40",
|
|
"code":"45"
|
|
},
|
|
{
|
|
"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":"Appendix",
|
|
"uri":"smn_api_a0000.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"46"
|
|
},
|
|
{
|
|
"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":"Topic Attribute List",
|
|
"uri":"smn_api_a1000.html",
|
|
"doc_type":"api",
|
|
"p_code":"46",
|
|
"code":"47"
|
|
},
|
|
{
|
|
"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":"Change History",
|
|
"uri":"smn_api_b0000.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"48"
|
|
}
|
|
] |