API標準及多語言預置SDK
本產品(Mns-open/2022-01-19)的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK,開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜,需花費 5個工作日左右。因此建議加入我們的服務DingTalk群(147535001692),在專家指導下進行簽名對接。
在使用API前,您需要準備好身份帳號及存取金鑰(AccessKey),才能有效通過用戶端工具(SDK、CLI等)訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求,需通過自簽名方式對接 API,建議優先諮詢我們的支援人員團隊(服務DingTalk群:147535001692),擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露,所有相關資源都將面臨未經授權訪問的風險。為確保安全,建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey,同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下,才使用阿里雲帳號。
主題管理
|
API |
標題 |
API概述 |
| CreateTopic | 建立主題。 | 呼叫 CreateTopic 介面建立主題。 |
| SetTopicAttributes | 修改主題的屬性。 | 呼叫 SetTopicAttributes 介面來修改主題的屬性。 |
| GetTopicAttributes | 取得主題的屬性。 | 呼叫 GetTopicAttributes 介面取得主題的屬性。 |
| DeleteTopic | 刪除主題 | 調用DeleteTopic介面刪除主題。 |
| ListTopic | 查詢阿里雲帳號下的主題清單。 | 呼叫 ListTopic 介面查詢阿里雲帳號下的主題清單,可分頁獲取資料。 |
佇列管理
|
API |
標題 |
API概述 |
| CreateQueue | 建立佇列。 | 呼叫 CreateQueue 介面建立一個新的佇列。 |
| SetQueueAttributes | 修改佇列屬性。 | 呼叫 SetQueueAttributes 介面修改佇列屬性。 |
| GetQueueAttributes | 取得佇列屬性。 | 取得某個已建立佇列的屬性。 |
| DeleteQueue | 刪除佇列 | 呼叫 DeleteQueue 介面刪除已建立的佇列。 |
| ListQueue | 列出指定阿里雲帳號下的所有佇列。 | 呼叫 ListQueue 介面,列出指定阿里雲帳號下的所有佇列,可分頁獲取資料。 |
訂閱管理
|
API |
標題 |
API概述 |
| Subscribe | 為主題建立 Subscription。 | 呼叫 Subscribe 介面,為主題建立 Subscription。 |
| SetSubscriptionAttributes | 修改Subscription的屬性 | 調用SetSubscriptionAttributes介面修改Subscription的屬性。 |
| GetSubscriptionAttributes | 擷取Subscription的屬性 | 調用GetSubscriptionAttributes介面擷取Subscription的屬性。 |
| Unsubscribe | 取消已建立的Subscription | 調用Unsubscribe介面取消一個已建立的Subscription。 |
| ListSubscriptionByTopic | 列出主題下的Subscription列表 | 調用ListSubscriptionByTopic介面列出某個主題下的Subscription列表,可分頁擷取資料。 |
存取點管理
|
API |
標題 |
API概述 |
| DisableEndpoint | 關閉存取點 | 本介面用於關閉指定類型存取點。關閉後,所有源自對應存取點的請求都將被攔截並返回錯誤。 |
| EnableEndpoint | 啟用存取點 | 本介面用於啟用指定類型的存取點。開啟後,源自對應存取點且處於Acl白名單中的請求都將不會被攔截。 |
| GetEndpointAttribute | 擷取存取點屬性 | GetEndpointAttribute |
| RevokeEndpointAcl | 刪除存取點Acl規則 | 本介面用於刪除指定類型的存取點的一條或多條Acl規則。 |
| AuthorizeEndpointAcl | 增加存取點Acl規則 | 本介面用於新增指定類型的存取點的一條或多條Acl規則。 |
事件通知管理
|
API |
標題 |
API概述 |
| GetEventRule | 擷取事件通知規則 | 擷取事件通知規則。 |
| ListEventRules | 擷取事件規則列表 | 查詢事件通知清單。 |
| CreateEventRule | 建立事件規則 | 用於建立事件規則。 |
| DeleteEventRule | 刪除事件規則 | 用於刪除事件規則。 |
其他
|
API |
標題 |
API概述 |
| GetAccountAttributes | 取得使用者日誌設定。 | 取得使用者日誌設定。 |