本產品(
云網管/2020-08-25
)的OpenAPI采用RPC簽名風格,簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK,開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜,需花費 5個工作日左右。因此建議加入我們的服務釘釘群(78410016550),在專家指導下進行簽名對接。在使用API前,您需要準備好身份賬號及訪問密鑰(AccessKey),才能有效通過客戶端工具(SDK、CLI等)訪問API。細節請參見獲取AccessKey。
API目錄
API | 標題 | API概述 |
---|---|---|
ListRegions | 查詢可用地域列表 | 獲取產品已上線可使用的地域信息。 |
ListInstances | 獲取實例列表 | 查詢用戶創建的所有實例列表。 |
UpdateInstance | 編輯實例 | 修改實例名稱。 |
資源管理相關
API | 標題 | API概述 |
---|---|---|
CreateDedicatedLine | 創建新的專線 | 創建新的專線。 |
ListDedicatedLines | ListDedicatedLines | 分頁獲取專線列表。 |
GetDedicatedLine | 根據ID查詢專線詳情 | 根據ID查詢專線詳情。 |
UpdateDedicatedLine | 根據ID編輯專線信息 | 根據ID編輯專線信息。 |
DeleteDedicatedLine | 根據ID刪除專線 | 根據ID刪除專線。 |
CreateDevice | 創建新的設備 | 創建新的設備。 |
ListDevices | 分頁獲取設備列表 | 分頁獲取設備列表。 |
GetDevice | 根據ID查詢設備詳情 | 根據ID查詢設備詳情。 |
CreateDevices | 批量導入設備 | 批量導入設備。 |
GetDeviceConfig | 根據ID查詢設備配置詳情 | 根據ID查詢設備配置詳情。 |
GetDeviceConfigDiff | 根據查詢設備配置DIFF | 根據查詢設備配置DIFF。 |
GetDeviceOpLog | 查詢設備操作日志 | 分頁查詢設備操作日志。 |
GetDeviceConfigDate | 查詢設備配置變化日期 | 查詢設備配置變化日期列表。 |
UpdateDevice | 根據ID編輯設備 | 根據ID編輯設備。 |
UpdateDevices | 批量編輯設備的賬號密碼等 | 批量編輯設備的賬號密碼等。 |
DeleteDevice | 刪除設備 | 根據ID刪除設備。 |
DeleteDevices | 批量刪除設備 | 批量刪除設備。 |
CreateDeviceForm | 創建新的設備形態 | 創建新的設備形態。 |
ListDeviceForms | 獲取設備形態列表 | 獲取設備形態列表。 |
GetDeviceForm | 根據ID查詢設備形態詳情 | 根據ID查詢設備形態詳情。 |
UpdateDeviceForm | 編輯已經存在的設備形態 | 編輯已經存在的設備形態。 |
DeleteDeviceForm | 根據ID刪除設備形態 | 根據ID刪除設備形態。 |
CreateDeviceProperty | 創建新的設備屬性 | 創建新的設備屬性。 |
ListDeviceProperties | 獲取設備屬性列表 | 獲取設備屬性列表。 |
GetDeviceProperty | 根據ID查詢設備屬性詳情 | 根據ID查詢設備屬性詳情。 |
ListDeviceValues | 獲取設備屬性值的列表 | 獲取設備屬性值的列表。 |
UpdateDeviceProperty | 根據ID編輯設備屬性 | 根據ID編輯設備屬性。 |
DeleteDeviceProperty | 根據ID刪除設備屬性 | 根據ID刪除設備屬性。 |
CreatePhysicalSpace | 創建新的物理空間 | 創建新的物理空間。 |
ListPhysicalSpaces | 獲取物理空間列表 | 分頁獲取物理空間列表。 |
ListTreePhysicalSpaces | 獲取物理空間列表 | 獲取物理空間列表,以樹形方式返回。 |
GetPhysicalSpace | 根據ID查詢物理空間詳情 | 根據ID查詢物理空間詳情。 |
UpdatePhysicalSpace | 根據ID編輯物理空間 | 根據ID編輯物理空間。 |
DeletePhysicalSpace | 根據ID刪除物理空間 | 根據ID刪除物理空間。 |
ListIpBlocks | ListIpBlocks | ListIpBlocks |
監控相關
API | 標題 | API概述 |
---|---|---|
CreateMonitorItem | 創建監控項 | 創建監控項。 |
GetMonitorItem | 查詢監控項詳情 | 根據監控項ID查詢監控項詳情。 |
CreateTimePeriod | 創建時間范圍 | 創建時間范圍。 |
ListAlarmStatus | 獲取監控狀態列表 | 獲取監控狀態列表,包括單設備監控狀態、專線監控狀態及聚合數據監控狀態。 |
ListAlarmStatusHistories | 獲取監控狀態的歷史時序數據 | 獲取監控狀態的歷史時序數據。 |
ListAlarmStatusStatistics | 獲取告警統計 | 獲取告警統計。 |
GetAlarmStatus | 獲取告警狀態詳情 | 獲取告警狀態詳情,包含告警狀態、時間、結果等內容。 |
ListMonitorData | 獲取監控時序數據 | 獲取監控時序數據。 |
ListNotificationHistories | 獲取通知發送的歷史記錄列表 | 獲取通知發送的歷史記錄列表。 |
ListNotificationHistoriesStatistics | ListNotificationHistoriesStatistics | 獲取通知記錄統計 |
EnableNotification | 啟用監控項的告警通知功能 | 啟用監控項的告警通知功能。 |
DisableNotification | 將監控項通知功能禁用到指定時間 | 將監控項通知功能禁用到指定時間。 |
CreateEventDefinition | 創建事件定義 | 創建事件定義。 |
ListEventDefinitions | 獲取事件定義列表 | 獲取事件定義列表。 |
UpdateEventDefinition | 更新事件定義 | 更新事件定義。 |
DeleteEventDefinition | 刪除事件定義 | 刪除事件定義。 |
ListEvents | 獲取事件列表 | 獲取事件列表。 |
CloseEvent | 關閉事件 | 關閉正在告警的事件。 |
ListLogs | 查詢syslog日志 | 查詢syslog日志。 |
巡檢相關
API | 標題 | API概述 |
---|---|---|
ListInspectionTasks | 獲取巡檢任務列表 | 獲取巡檢任務列表。 |
ListInspectionDevices | 獲取巡檢設備列表 | 獲取巡檢設備列表信息。 |
CreateRealtimeTask | 創建實時任務 | 創建實時任務。 |
CreateTask | 創建巡檢任務 | 創建巡檢任務。 |
RetryTasks | 重試巡檢任務 | 重試巡檢任務。 |
GetTask | 查詢巡檢任務 | 查詢巡檢任務詳情。 |
GetRealtimeTask | 獲取實時任務詳情 | 獲取實時任務詳情。 |
ListTasksHistories | 獲取任務歷史列表 | 獲取任務歷史列表。 |
GetInspectionTask | 獲取巡檢任務詳情 | 獲取巡檢任務詳情。 |
其他
API | 標題 | API概述 |
---|---|---|
DeleteSpaceModel | DeleteSpaceModel | |
CreateOsVersion | 創建OS版本 | 創建OS版本。 |
UpdateSpaceModel | UpdateSpaceModel | |
GetSpaceModelInstance | GetSpaceModelInstance | |
ListOsVersions | ListOsVersions | |
UpdateSpaceModelInstance | 更新關聯物理空間模型 | 更新關聯物理空間模型。 |
GetSpaceModel | GetSpaceModel | |
GetOssPolicy | 獲取下載簽名 | 獲取下載文件時的簽名參數。 |
GetSpaceModelSort | GetSpaceModelSort | |
LockSpaceModel | 鎖定物理空間模型 | |
ListSpaceModels | ListSpaceModels | |
CreateSpaceModel | CreateSpaceModel | |
GetOsVersion | 獲取鏡像版本 | 獲取鏡像版本下載地址。 |
UpdateOsVersion | UpdateOsVersion | |
DeleteOsVersion | DeleteOsVersion | |
DeleteDeliveryArchVersion | DeleteDeliveryArchVersion |