本產(chǎn)品（
5G高速上云服務/2022-03-14）的OpenAPI采用RPC簽名風格，簽名細節(jié)參見簽名機制說明。我們已經(jīng)為開發(fā)者封裝了常見編程語言的SDK，開發(fā)者可通過下載SDK直接調(diào)用本產(chǎn)品OpenAPI而無需關心技術細節(jié)。如果現(xiàn)有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節(jié)非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（11370001915），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節(jié)請參見獲取AccessKey。
地域信息
| API | 標題 | API概述 |
|---|---|---|
| ListRegions | 查詢可用地域列表 | 查詢5G高速上云服務支持的地域列表。 |
| ListZones | 查詢可用區(qū)的列表 | 查詢5G高速上云服務支持的可用區(qū)列表。 |
權限管理
| API | 標題 | API概述 |
|---|---|---|
| OpenCc5gService | 開通服務 | 開通5G高速上云服務。 |
| GetCreateCustomerInformation | 獲取客戶資料錄入地址和錄入狀態(tài) | 獲取客戶資料錄入地址和錄入狀態(tài)。 |
5G上云實例
| API | 標題 | API概述 |
|---|---|---|
| ListAPNs | 查詢APN列表 | 查詢5G高速上云服務支持的APN列表。 |
| CreateWirelessCloudConnector | 創(chuàng)建5G高速上云服務實例 | 創(chuàng)建5G高速上云服務實例。 |
| DeleteWirelessCloudConnector | 刪除5G高速上云實例 | 刪除5G高速上云實例。 |
| UpdateWirelessCloudConnector | 更新5G高速上云實例 | 更新5G高速上云實例信息。 |
| ListWirelessCloudConnectors | 查詢5G高速上云實例列表 | 查詢5G高速上云實例列表。 |
| AttachVpcToNetLink | 關聯(lián)用戶Vpc和Vswitch | 關聯(lián)用戶Vpc和Vswitch到5G高速上云實例。 |
| DetachVpcFromNetLink | 取消關聯(lián)Vpc和Vswitch | 取消用戶Vpc和Vswitch的關聯(lián)。 |
| GetWirelessCloudConnector | 查詢5G高速上云實例詳情 | 查詢5G高速上云實例詳細信息。 |
| ListDataPackages | 查詢流量包信息 | 查詢流量包信息列表。 |
| CreateIoTCloudConnectorBackhaulRoute | 創(chuàng)建5G高速上云實例反向訪問路由 | 開啟了反向訪問高級特性場景下，針對連接實例下發(fā)反向訪問路由。 |
| DeleteIoTCloudConnectorBackhaulRoute | 刪除5G高速上云實例反向訪問路由 | 開啟了反向訪問高級特性場景下，針對連接實例刪除反向訪問路由 。 |
| ModifyWirelessCloudConnectorFeature | 修改5G高速上云實例高級屬性 | 修改5G高速上云實例高級屬性，例如開啟反向訪問功能。 |
| ListIoTCloudConnectorBackhaulRoute | 查詢5G高速上云實例反向訪問路由 | 開啟了反向訪問高級特性場景下，查詢特定連接實例的反向訪問路由列表。 |
| SwitchWirelessCloudConnectorToBusiness | 切換5G上云服務實例到商業(yè)模式 | 用于把5G上云服務測試實例切換到商業(yè)實例。 |
訂單管理
| API | 標題 | API概述 |
|---|---|---|
| ListOrders | 查詢訂單列表 | 查詢訂單列表。 |
卡管理
| API | 標題 | API概述 |
|---|---|---|
| LockCards | 批量鎖定卡 | 批量鎖定卡。 |
| UnlockCards | 批量解鎖卡 | 批量解鎖卡。 |
| StopCards | 卡停機操作 | 單卡停機，支持批量操作。 |
| ResumeCards | 激活/恢復卡狀態(tài) | 激活單卡，或恢復運營商側卡狀態(tài)，支持批量操作。 |
| UpdateCard | 更新卡信息 | 更新卡實例的名稱和描述。 |
| ListCards | 查詢5G高速上云實例下的卡信息 | 查詢5G高速上云實例下的卡信息列表。 |
| ListCardUsages | 查詢卡流量使用信息 | 查詢物聯(lián)網(wǎng)卡流量使用信息。 |
| GetCard | 獲取單卡信息 | 獲取單卡信息。 |
| GetCardLockReason | 獲取鎖卡原因 | 獲取鎖卡原因。 |
| FailCards | 銷卡 | 銷卡。 |
| RebindCards | 換綁解鎖單卡 | 換綁解鎖單卡。 |
| ListCardDayUsages | 查詢單卡單日流量 | 查詢單卡單日流量。 |
| ResetAreaLimitCards | 區(qū)域限制解鎖 | 物聯(lián)網(wǎng)卡區(qū)域限制解鎖 |
| ListCardAreaLimitSupportArea | 查詢卡區(qū)域解鎖支持的省份 | 查詢卡區(qū)域解鎖支持的省份。 |
授權規(guī)則
| API | 標題 | API概述 |
|---|---|---|
| CreateAuthorizationRule | 創(chuàng)建授權規(guī)則 | 創(chuàng)建授權規(guī)則。 |
| DeleteAuthorizationRule | 刪除授權規(guī)則 | 刪除授權規(guī)則。 |
| UpdateAuthorizationRule | 更新授權規(guī)則 | 更新授權規(guī)則。 |
| AddDNSAuthorizationRule | 創(chuàng)建DNS授權規(guī)則 | 創(chuàng)建DNS授權規(guī)則。 |
| UpdateDNSAuthorizationRule | 更新DNS授權規(guī)則 | 更新DNS授權規(guī)則。 |
| ListAuthorizationRules | 查詢授權規(guī)則 | 查詢授權規(guī)則列表。 |
卡批量操作
| API | 標題 | API概述 |
|---|---|---|
| CreateBatchOperateCardsTask | 創(chuàng)建批量操作卡任務 | 創(chuàng)建批量操作卡任務。 |
| DeleteBatchOperateCardsTask | 刪除批量操作卡任務 | 刪除批量操作卡任務。 |
| UpdateBatchOperateCardsTask | 更新批量操作卡任務 | 更新批量操作卡任務。 |
| ListBatchOperateCardsTasks | 列出批量操作卡任務 | 列出批量操作卡任務。 |
網(wǎng)絡診斷
| API | 標題 | API概述 |
|---|---|---|
| SubmitDiagnoseTaskForSingleCard | 發(fā)起單卡網(wǎng)絡診斷 | 發(fā)起單張物聯(lián)網(wǎng)卡的網(wǎng)絡診斷。 |
| GetDiagnoseResultForSingleCard | 查詢單卡診斷結果 | 查詢單張物聯(lián)網(wǎng)卡的網(wǎng)絡診斷結果。 |
| ListDiagnoseInfoForSingleCard | 查詢歷史診斷記錄 | 查詢5G上云實例的歷史診斷信息（不包含診斷結果）。 |
授權分享
| API | 標題 | API概述 |
|---|---|---|
| GrantNetLink | 授權云連接器 | 授權云連接器給第三方客戶。 |
| RevokeNetLink | 撤銷授權 | 主動撤銷之前授權動作。 |
實例組
| API | 標題 | API概述 |
|---|---|---|
| CreateWirelessCloudConnectorGroup | 創(chuàng)建分組 | 創(chuàng)建cc5g實例分組。 |
| UpdateWirelessCloudConnectorGroup | 更新分組信息 | 修改cc5g實例分組信息。 |
| ListWirelessCloudConnectorGroups | 查詢分組信息 | 查詢cc5g實例分組。 |
| DeleteWirelessCloudConnectorGroup | 刪除分組 | 刪除cc5g實例分組。 |
| AddWirelessCloudConnectorToGroup | 給分組增加cc5g實例 | 給cc5g實例分組增加cc5g實例。 |
| RemoveWirelessCloudConnectorFromGroup | 從分組中移除cc5g實例 | 從cc5g實例分組移除cc5g實例。 |
| CreateGroupAuthorizationRule | 創(chuàng)建分組授權規(guī)則 | 創(chuàng)建cc5g分組的授權規(guī)則。 |
| UpdateGroupAuthorizationRule | 更新分組授權規(guī)則 | 修改cc5g實例組的授權規(guī)則。 |
| ListGroupAuthorizationRules | 查詢分組授權規(guī)則列表 | 查詢分組的授權規(guī)則列表。 |
| DeleteGroupAuthorizationRule | 刪除分組授權規(guī)則 | 刪除cc5g分組授權規(guī)則。 |
| AddGroupDnsAuthorizationRule | 創(chuàng)建分組DNS授權規(guī)則 | 實例組創(chuàng)建DNS授權規(guī)則。 |
| UpdateGroupDnsAuthorizationRule | 更新分組DNS授權規(guī)則 | 修改實例組的DNS授權規(guī)則。 |