本產品(
云連接器/2021-05-13
)的OpenAPI采用RPC簽名風格,簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK,開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜,需花費 5個工作日左右。因此建議加入我們的服務釘釘群(11370001915),在專家指導下進行簽名對接。在使用API前,您需要準備好身份賬號及訪問密鑰(AccessKey),才能有效通過客戶端工具(SDK、CLI等)訪問API。細節請參見獲取AccessKey。
服務開通
API | 標題 | API概述 |
---|---|---|
OpenIoTCloudConnectorService | 開通云連接器服務 | 開通云連接器服務。 |
地域
API | 標題 | API概述 |
---|---|---|
ListRegions | 查詢云連接器支持的地域列表 | 查詢云連接器支持的地域列表。 |
APN
API | 標題 | API概述 |
---|---|---|
ListAPNs | 查詢APN | 查詢云連接器實例支持的APN列表。 |
云連接器
API | 標題 | API概述 |
---|---|---|
CreateIoTCloudConnector | 創建云連接器實例 | 創建云連接器實例。 |
UpdateIoTCloudConnectorAttribute | 更新云連接器實例信息 | 更新云連接器實例信息。 |
ListIoTCloudConnectors | 查詢云連接器實例信息 | 查詢云連接器實例信息。 |
ListIoTCloudConnectorAvailableZones | IoTCC實例綁定交換機可用區 | 查詢支持云連接器實例綁定交換機的可用區。 |
AssociateVSwitchWithIoTCloudConnector | 交換機與云連接器實例進行關聯 | 將交換機與云連接器實例進行關聯。 |
DissociateVSwitchFromIoTCloudConnector | 解綁vsw/vpc | 將交換機與云連接器實例解關聯。 |
ListIoTCloudConnectorEIPs | 查詢云連接器實例關聯的彈性公網IP列表 | 調用ListIoTCloudConnectorEIPs接口查詢云連接器實例關聯的彈性公網IP列表。 |
DeleteIoTCloudConnector | 刪除云連接器實例 | 刪除云連接器實例。 |
連接池
API | 標題 | API概述 |
---|---|---|
CreateConnectionPool | 創建連接地址池 | 創建連接地址池。 |
AddCidrToConnectionPool | 連接池增加連接IP段 | 連接池增加連接IP段,主要用于動態IP增加IP方式,區別于單個卡IP添加方式。 |
UpdateConnectionPoolAttribute | 更新連接地址池 | 更新連接地址池。 |
ListConnectionPools | 查詢云連接地址池 | 查詢云連接地址池。 |
ListConnectionPoolIps | 查詢連接地址池中的IP地址狀態 | 查詢連接地址池中的IP地址狀態信息。 |
GetStsInfoAndOssPath | 獲取服務賬號信息和提交地址 | 獲取服務賬號STS信息和模板文件臨時提交地址。 |
AssociateIpWithConnectionPool | 綁定IP地址與云連接器關聯的連接地址池 | 綁定某個已存在的IP訪問控制。 |
DissociateIpFromConnectionPool | 解綁卡IP | 解除IP地址與云連接器關聯的連接地址池的綁定關系。 |
GetConnectionPoolIpOperationResult | 獲取IP地址綁定與解綁結果 | 獲取IP地址與連接地址池綁定與解綁的操作結果。 |
ListConnectionPoolAllIps | 查詢連接地址池所有IP地址 | 查詢連接地址池所有IP地址信息。 |
DeleteConnectionPool | 刪除連接地址池 | 刪除連接地址池。 |
授權規則
API | 標題 | API概述 |
---|---|---|
CreateAuthorizationRule | 創建授權規則 | 創建授權規則。 |
CreateAuthorizationRules | 創建多條授權規則 | 調用CreateAuthorizationRules接口創建多條授權規則。 |
UpdateAuthorizationRuleAttribute | 更新授權規則信息 | 更新授權規則信息。 |
ListAuthorizationRules | 查詢授權規則 | 查詢授權規則信息。 |
DeleteAuthorizationRule | 刪除授權規則 | 刪除授權規則。 |
實例組
API | 標題 | API概述 |
---|---|---|
CreateIoTCloudConnectorGroup | 創建實例組 | 創建實例組。 |
AddIoTCloudConnectorToGroup | 添加云連接器到分組中 | 為實例組添加云連接器實例。 |
UpdateIoTCloudConnectorGroupAttribute | 修改云連接器分組屬性 | 修改云連接器分組屬性。 |
ListIoTCloudConnectorGroups | 查詢實例組列表信息 | 查詢實例組列表信息。 |
RemoveIoTCloudConnectorFromGroup | 將云連接器實例從實例組中移除 | 將云連接器實例從實例組中移除。 |
DeleteIoTCloudConnectorGroup | 刪除實例組 | 刪除實例組。 |
實例組授權規則
API | 標題 | API概述 |
---|---|---|
CreateGroupAuthorizationRule | 實例組創建授權規則 | 實例組創建授權規則。 |
UpdateGroupAuthorizationRuleAttribute | 修改實例組的授權規則 | 修改實例組的授權規則。 |
ListGroupAuthorizationRules | 查詢實例組的授權規則 | 查詢實例組的授權規則信息。 |
DeleteGroupAuthorizationRule | 刪除實例組的授權規則 | 刪除實例組的授權規則。 |
授權VBR
API | 標題 | API概述 |
---|---|---|
GrantVirtualBorderRouter | 授權綁定VBR | 獲取邊界路由器VBR的服務關聯角色SLR權限。 |
DNS授權規則
API | 標題 | API概述 |
---|---|---|
CreateDNSServiceRule | 創建DNS授權規則 | 創建DNS授權規則。 |
UpdateDNSServiceRuleAttribute | 修改DNS授權規則 | 修改DNS授權規則。 |
ListDNSServiceRules | 查詢DNS授權規則 | 查詢DNS授權規則。 |
DeleteDNSServiceRule | 刪除DNS授權規則 | 刪除DNS授權規則。 |
MoveAuthorizationRuleToDNSService | 授權規則轉移到DNS授權規則 | 將授權規則轉移到DNS授權規則中。 |
實例組DNS授權規則
API | 標題 | API概述 |
---|---|---|
CreateGroupDNSServiceRule | 實例組創建DNS授權規則 | 實例組創建DNS授權規則。 |
UpdateGroupDNSServiceRuleAttribute | 改實例組的DNS授權規則 | 修改實例組的DNS授權規則。 |
ListGroupDNSServiceRules | 查詢實例組的DNS授權規則 | 查詢實例組的DNS授權規則。 |
MoveGroupAuthorizationRuleToDNSService | 實例組規則轉移到DNS授權規則 | 將實例組的授權規則轉移到DNS授權規則中。 |
DeleteGroupDNSServiceRule | 刪除實例組的DNS授權規則 | 刪除實例組的DNS授權規則。 |
訪問日志
API | 標題 | API概述 |
---|---|---|
EnableIoTCloudConnectorAccessLog | 開啟訪問日志功能 | 指定云連接器開啟訪問日志功能。 |
DisableIoTCloudConnectorAccessLog | 關閉訪問日志功能 | 關閉訪問日志功能。 |
GetIoTCloudConnectorAccessLog | 獲取指定云連接器訪問日志 | 獲取指定云連接器訪問日志狀態信息。 |
分應用統計服務
API | 標題 | API概述 |
---|---|---|
CreateService | 創建分應用統計服務 | 創建分應用統計服務。 |
UpdateServiceAttribute | 修改分應用統計服務 | 修改分應用統計服務。 |
ListService | 查詢分應用統計服務 | 查詢分應用統計服務。 |
DeleteService | 刪除分應用統計服務 | 刪除分應用統計服務。 |
應用條目
API | 標題 | API概述 |
---|---|---|
CreateServiceEntry | 分應用功能列表中添加應用條目 | 分應用統計服務列表中添加應用條目。 |
UpdateServiceEntryAttribute | 修改分應用統計列表的應用條目 | 修改分應用統計服務列表中的應用條目。 |
ListServiceEntries | 查詢分應用統計條目 | 查詢分應用統計條目。 |
DeleteServiceEntry | 刪除分應用統計條目 | 刪除分應用統計條目。 |
網絡診斷
API | 標題 | API概述 |
---|---|---|
SubmitDiagnoseTaskForSingleCard | 提交單卡診斷任務 | 提交單卡診斷任務。 |
GetDiagnoseResultForSingleCard | 獲取單卡診斷結果 | 獲取單卡診斷結果。 |
ListDiagnoseInfoForSingleCard | 查詢單卡診斷的診斷結果信息 | 查詢單卡診斷的診斷結果信息。 |
回程路由
API | 標題 | API概述 |
---|---|---|
CreateIoTCloudConnectorBackhaulRoute | 創建當前云連接器實例綁定VPC后的回程路由 | 調用CreateIoTCloudConnectorBackhaulRoute接口創建當前云連接器實例綁定VPC后的回程路由。 |
ListIoTCoudConnectorBackhaulRoute | 查詢當前云連接器實例綁定VPC后的回程路由 | 調用ListIoTCoudConnectorBackhaulRoute接口查詢當前云連接器實例綁定VPC后的回程路由。 |
DeleteIoTCloudConnetorBackhaulRoute | 刪除當前云連接器實例綁定VPC后的回程路由 | 調用DeleteIoTCloudConnetorBackhaulRoute接口刪除當前云連接器實例綁定VPC后的回程路由。 |
授權規則IP重定向
API | 標題 | API概述 |
---|---|---|
CreateIpMappingRule | 創建授權規則IP的重定向功能 | 調用CreateIpMappingRule接口創建授權規則IP的重定向功能。 |
UpdateIpMappingRule | 修改授權規則IP重定向的相關信息 | 調用UpdateIpMappingRule接口修改授權規則IP重定向的相關信息。 |
ListIpMappingRules | 查詢授權規則IP重定向信息 | 調用ListIpMappingRules接口查詢授權規則IP重定向信息。 |
DeleteIpMappingRule | 刪除授權規則IP重定向信息 | 調用DeleteIpMappingRule接口刪除授權規則IP重定向信息。 |
實例組授權規則IP重定向
API | 標題 | API概述 |
---|---|---|
CreateGroupIpMappingRule | 創建實例組授權規則IP的重定向規則 | 調用CreateGroupIpMappingRule接口創建實例組授權規則IP的重定向規則。 |
UpdateGroupIpMappingRule | 修改實例組授權規則IP重定向的相關信 | 調用UpdateGroupIpMappingRule接口修改實例組授權規則IP重定向的相關信息。 |
ListGroupIpMappingRules | 查詢實例組授權規則IP重定向信息 | 調用ListGroupIpMappingRules接口查詢實例組授權規則IP重定向信息。 |
DeleteGroupIpMappingRule | 刪除實例組授權規則IP重定向信息 | 調用DeleteGroupIpMappingRule接口刪除實例組授權規則IP重定向信息。 |
實例過戶
API | 標題 | API概述 |
---|---|---|
ConfirmIoTCloudConnector | 確認或拒絕云連接器實例過戶 | 調用ConfirmIoTCloudConnector接口確認或拒絕云連接器實例過戶。 |
RevertIoTCloudConnector | 歸還已拒絕過戶的云連接器實例 | 調用RevertIoTCloudConnector接口歸還已拒絕過戶的云連接器實例。 |
其他
API | 標題 | API概述 |
---|---|---|
DeleteAuthorizationRules | 批量刪除授權規則 | 批量刪除授權規則。 |