辦公安全平臺不僅提供可視化操作控制臺,還提供OpenAPI在線調試、阿里云SDK調用方式,幫助您更高效地進行開發與部署。
OpenAPI介紹
為了讓開發者能夠快速高效地學習和使用云產品OpenAPI,阿里云為用戶提供OpenAPI網站。它是一款集OpenAPI智能搜索、文檔、在線調試、SDK獲取、CodeSample、調用出錯診斷、調用統計為一體的產品。您可以在OpenAPI門戶中調用阿里云各云產品開放的OpenAPI,查看OpenAPI請求和返回結果。此外,OpenAPI門戶會自動生成相應的SDK調用示例,幫助您快速使用阿里云產品。更多信息,請參見什么是OpenAPI。
版本說明
阿里云OpenAPI通過版本號管控各時期云產品大版本的API列表,例如辦公安全平臺目前支持2023-01-20
版本的API列表,2023-01-20
代表的是API版本號而非時間概念,所展示的都是最新的API公開數據,并非自2023-01-20
之后就未更新。
版本號 | 說明 |
推薦使用 |
在線調試
辦公安全平臺在OpenAPI門戶提供API調試等功能。在調用前,您需要了解辦公安全平臺提供的版本、接入點、接口風格、調用方式等信息。
調試API入口為:https://api.aliyun.com/api/csas/2023-01-20
接入點說明
根據相關資源所在地域,選擇對應的服務接入點地址,以獲得最低延遲。例如華東1(杭州)的辦公安全平臺公網接入地址為csas.aliyuncs.com
,VPC接入地址為csas-vpc.cn-hangzhou.aliyuncs.com
。
公網接入地址在全球都可訪問。
VPC接入地址只有在阿里云對應的地域內,且是VPC網絡類型才可訪問。VPC地址的優勢:
高安全性:VPC服務地址只能在VPC內部訪問,提供更高的安全性和隱私性。
更快的響應速度:由于VPC服務地址在VPC內部網絡中運行,其響應速度通常比公網服務更快,且可以避免公網延遲和帶寬限制等問題。
更低的成本:VPC服務地址可以使用內部網絡通信。
更多信息,請參見服務接入點。
支持的調用身份
您阿里云賬號登錄OpenAPI網站后,OpenAPI默認使用您的阿里云賬號進行在線OpenAPI調試。阿里云賬號擁有所有API的訪問權限,風險很高。強烈建議您創建并使用RAM用戶進行API訪問或日常運維。請根據業務的實際情況按需分配權限后進行接口調用。RAM用戶需具備操作權限,詳情請參見使用RAM進行訪問控制。
用戶身份 | 支持情況 |
支持 | |
RAM用戶(推薦) | 支持 |
RAM角色(推薦) | 支持 |
更多信息
集成方式
SDK是最易于集成,且支持度最好的OpenAPI調用方式,推薦您選擇使用SDK。
集成方式 | 支持情況 |
支持 | |
不支持 | |
不支持 | |
不支持 | |
不支持 |
阿里云SDK
阿里云CLI
阿里云命令行工具可以幫您在使用命令行終端時,使用
aliyun
命令與阿里云服務進行交互,管理云服務資源。有關阿里云CLI的更多詳細信息,請參見什么是阿里云CLI。暫不支持使用阿里云CLI調用辦公安全平臺
資源編排ROS
資源編排服務ROS(Resource Orchestration Service)是阿里云提供的一項簡化云計算資源管理的服務。開發者和管理員可以編寫模板,在模板中定義所需的阿里云資源(例如:ECS 實例、RDS 數據庫實例)、資源間的依賴關系等。ROS 的編排引擎將根據模板自動完成所有資源的創建和配置,實現自動化部署及運維。更多詳情請參見什么是資源編排服務。
暫不支持使用資源編排ROS調用辦公安全平臺。
Terraform
Terraform 是一種開源工具,用于安全高效地預覽,配置和管理云基礎架構和資源。它與阿里云的資源編排服務的運行機制類似,通過將模板轉化為內部數據后完成OpenAPI調用。更多詳情請參見什么是Terraform。
暫不支持使用Terraform調用辦公安全平臺。
自定義封裝API調用
暫不支持使用自定義封裝API調用辦公安全平臺。
注意事項
單個阿里云賬號調用不同API的每秒請求數(QPS)不同,詳情請參見各API文檔的QPS限制。
說明單個阿里云賬號下的所有RAM用戶共享該阿里云賬號的QPS配額。
您可以記錄下調用返回的RequestID或SDK報錯信息,通過阿里云OpenAPI診斷平臺進行自助診斷。