办公安全平台不仅提供可视化操作控制台，还提供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-20OpenAPI 门户的调试界面分为三个区域：左侧为 API 列表导航树（例如当前选中的查询身份源配置信息 ListIdpConfigs），中间为参数配置面板，包含服务地址下拉框（如华东1（杭州））、输入参数 Include（指定的身份源配置类型）、CurrentPage（当前页码）、PageSize（分页大小）以及发起调用按钮，右侧为请求参数文档说明。
接入点说明
根据相关资源所在地域，选择对应的服务接入点地址，以获得最低延迟。例如华东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诊断平台进行自助诊断。