API标准及多语言预置SDK
本产品（办公安全平台/2023-01-20）的 OpenAPI 采用 RPC 签名机制，具体签名方式请参见签名机制说明。我们已为开发者封装了主流编程语言的 SDK，您可通过 下载 SDK 快速调用 API，无需关注签名等底层实现细节，显著降低开发门槛与集成复杂度。自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的 RAM 用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
企业加速
| API | 标题 | API概述 |
|---|---|---|
| DeleteEnterpriseAcceleratePolicy | 删除企业加速策略 | 删除企业加速策略。 |
| DisableEnterpriseAcceleratePolicy | 禁用企业加速策略 | 禁用企业加速策略。 |
| ListEnterpriseAcceleratePolicies | 查询企业加速策略列表 | 查询加速策略列表 |
| ListEnterpriseAccelerateTargets | 查询企业加速地址列表 | 查询企业加速地址列表。 |
| ListEnterpriseAccelerateLogs | 查询企业加速审计日志 | 查询企业加速审计日志。 |
| ImportEnterpriseAccelerateTargets | 批量导入加速地址列表 | 批量导入加速地址列表。 |
| CreateEnterpriseAccelerateTarget | 创建企业加速地址 | 创建企业加速地址。 |
| EnableEnterpriseAcceleratePolicy | 启用企业加速策略 | 启用企业加速策略。 |
| DeleteEnterpriseAccelerateTarget | 删除企业加速地址 | 删除企业加速地址。 |
| ModifyEnterpriseAcceleratePolicy | 修改企业加速策略 | 修改企业加速策略。 |
| CreateEnterpriseAcceleratePolicy | 创建企业加速策略 | 创建企业加速策略。 |
动态决策
| API | 标题 | API概述 |
|---|---|---|
| ListDynamicDisposalProcesses | 批量查询动态策略处置流程 | 批量查询动态策略处置流程。 |
审批报备
| API | 标题 | API概述 |
|---|---|---|
| UpdateApprovalStatus | 更新审批实例状态 | 更新当前阿里云账号下审批实例状态。 |
| UpdateApprovalProcess | 更新审批流程 | 更新当前阿里云账号下审批流程。 |
| ListApprovals | 批量查询审批实例列表 | 查询当前阿里云账号下审批实例列表。 |
| ListApprovalSchemasForApprovalProcesses | 查询审批流程关联的模板 | 查询审批流程关联的渲染模板 |
| ListApprovalSchemas | 批量查询审批模板列表 | 查询当前阿里云账号下审批模板列表。 |
| ListApprovalProcessesForApprovalSchemas | 查询审批模板关联的流程 | 查询审批渲染模板关联的流程 |
| ListApprovalProcesses | 批量查询审批流程列表 | 查询当前阿里云账号下审批流程列表。 |
| GetApprovalSchema | 查询审批模板详情 | 查询当前阿里云账号下审批模板详情。 |
| GetApprovalProcess | 查询审批流程详情 | 查询当前阿里云账号下审批流程详情。 |
| GetApproval | 查询审批实例详情 | 查询当前阿里云账号下审批实例详情。 |
| DetachPolicy2ApprovalProcess | 解绑业务策略与审批流程 | 解绑业务策略与审批流程 |
| DeleteApprovalProcesses | 批量删除审批流程 | 批量删除当前阿里云账号下审批流程。 |
| AttachPolicy2ApprovalProcess | 绑定业务策略与审批流程 | 挂载业务策略至指定审批流程 |
| CreateApprovalProcess | 创建审批流程 | 创建当前阿里云账号下审批流程。 |
终端防卸载策略
| API | 标题 | API概述 |
|---|---|---|
| ListUninstallApplications | 批量查询卸载申请列表 | 批量查询当前阿里云账号下卸载申请列表。 |
| UpdateBootAndAntiUninstallPolicy | 更新自启动&防卸载策略 | 更新当前阿里云账号下自启动与防卸载策略。 |
| UpdateUninstallApplicationsStatus | 批量更新卸载申请状态 | 批量更新当前阿里云账号下卸载申请状态。 |
| GetBootAndAntiUninstallPolicy | 查询自启动&防卸载策略详情 | 查询当前阿里云账号下自启动与防卸载策略详情。 |
网络准入
| API | 标题 | API概述 |
|---|---|---|
| ListNacUserCert | 批量查询用户入网证书状态 | 入网用户列表。 |
| UpdateNacUserCertStatus | 批量修改用户入网证书状态 | 批量修改当前阿里云账号下用户入网证书状态。 |
身份源配置管理
| API | 标题 | API概述 |
|---|---|---|
| ListIdpConfigs | 查询身份源配置信息 | 查询当前阿里云账户身份源配置信息。 |
| GetIdpConfig | 查询身份源配置详情 | 查询当前阿里云账户指定的身份源配置详情信息。 |
| GetActiveIdpConfig | 查询已启用的身份源配置 | 查询当前阿里云账户已启用的身份源配置。 |
| 自定义身份源 | 自定义身份源 | |
| ListIdpDepartments | 查询自定义身份源部门 | 查询当前阿里云账户自定义身份源部门信息。 |
| CreateIdpDepartment | 创建自定义身份源部门 | 创建当前阿里云账户自定义身份源部门。 |
| ListClientUsers | 查询自定义身份用户信息 | 查询当前阿里云账户自定义身份源的用户信息。 |
| UpdateClientUser | 设置自定义身份源指定用户信息 | 设置当前阿里云账户自定义身份源指定用户的信息。 |
| GetClientUser | 查询自定义身份源用户详情 | 查询当前阿里云账户自定义身份源指定用户的详情信息。 |
| DeleteIdpDepartment | 删除自定义身份源指定部门 | 删除当前阿里云账户自定义身份源指定的部门。 |
| CreateClientUser | 创建自定义身份源用户 | 创建当前阿里云账户自定义身份源用户。 |
| UpdateIdpDepartment | 修改自定义身份源指定部门 | 删除当前阿里云账户自定义身份源指定的部门。 |
| UpdateClientUserStatus | 设置自定义身份源用户启用状态 | 设置当前阿里云账户自定义身份源指定用户的启用状态。 |
| DeleteClientUser | 删除自定义身份源指定用户 | 删除当前阿里云账户自定义身份源的指定用户。 |
| UpdateClientUserPassword | 设置自定义身份源指定用户的密码 | 设置当前阿里云账户自定义身份源指定用户的密码。 |
终端设备管理
| API | 标题 | API概述 |
|---|---|---|
| UpdateUserDevicesStatus | 批量修改用户终端设备状态 | 批量修改当前阿里云账号下终端设备状态。 |
| ListExcessiveDeviceRegistrationApplications | 批量查询设备超额注册申请 | 查询当前阿里云账号下用户终端设备的超额注册申请列表。 |
| UpdateExcessiveDeviceRegistrationApplicationsStatus | 批量修改设备超额注册申请状态 | 批量修改当前阿里云账号下超额注册申请状态。 |
| UpdateUserDevicesSharingStatus | 批量修改用户终端设备共享状态 | 批量修改企业用户的终端设备共享状态。 |
| ListUserDevices | 批量查询用户终端设备 | 查询当前阿里云账号下用户终端设备列表。 |
| ExportUserDevices | 导出用户终端设备列表 | 导出用户终端设备列表Excel文件。 |
| GetUserDevice | 查询用户终端设备详情 | 查询当前阿里云账号下用户终端设备详情。 |
| DeleteUserDevices | 批量删除用户终端设备 | 批量删除用户终端设备。 |
| ListSoftwareForUserDevice | 批量查询用户终端设备安装软件 | 查询当前阿里云账号下用户终端设备安装的软件列表。 |
设备注册策略
| API | 标题 | API概述 |
|---|---|---|
| ListRegistrationPolicies | 批量查询设备注册策略 | 查询当前阿里云账号下设备注册策略列表。 |
| ListUserGroupsForRegistrationPolicy | 批量查询设备注册策略的用户组 | 查询当前阿里云账号下设备注册策略相关用户组。 |
| ListRegistrationPoliciesForUserGroup | 批量查询用户组的设备注册策略 | 查询当前阿里云账号下用户组相关的设备注册策略。 |
| GetRegistrationPolicy | 查询设备注册策略详情 | 查询当前阿里云账号下设备注册策略详情。 |
| DeleteRegistrationPolicies | 批量删除设备注册策略 | 批量删除当前阿里云账号下设备注册策略。 |
| UpdateRegistrationPolicy | 修改设备注册策略 | 修改当前阿里云账号下设备注册策略。 |
| CreateRegistrationPolicy | 创建设备注册策略 | 创建当前阿里云账号下设备注册策略。 |
用户组
| API | 标题 | API概述 |
|---|---|---|
| ListUserGroups | 批量查询用户组 | 批量查询当前阿里云账号下所有用户组的信息。 |
| ListPolicesForUserGroup | 批量查询用户组的策略 | 批量查询当前阿里云账号下用户组的策略。 |
| GetUserGroup | 查询用户组详情 | 查询当前阿里云账号下的用户组详情。 |
| CreateUserGroup | 创建用户组 | 创建当前阿里云账号下用户组。 |
| DeleteUserGroup | 删除用户组 | 删除当前阿里云账号下用户组。 |
| UpdateUserGroup | 修改用户组 | 修改当前阿里云账号下用户组。 |
用户管理
| API | 标题 | API概述 |
|---|---|---|
| ListUserPrivateAccessPolicies | 查询用户零信任策略 | 列表查询用户零信任策略。 |
| ListUserApplications | 查询用户内网应用 | 查询当前阿里云账号下登录用户的应用权限。 |
| ListUsers | 批量查询用户 | 查询当前阿里云账号下登录用户列表。 |
| UpdateUsersStatus | 批量修改用户状态 | 批量修改当前阿里云账号下登录用户的状态。 |
内网访问应用
| API | 标题 | API概述 |
|---|---|---|
| ListPrivateAccessApplications | 批量查询内网访问应用 | 批量查询当前阿里云账号下所有内网访问应用的信息。 |
| ListTagsForPrivateAccessApplication | 批量查询内网访问应用的标签 | 批量查询当前阿里云账号下内网访问应用的标签。 |
| ListPolicesForPrivateAccessApplication | 批量查询内网访问应用的策略 | 批量查询当前阿里云账号下内网访问应用的策略。 |
| GetPrivateAccessApplication | 查询内网访问应用详情 | 查询当前阿里云账号下内网访问应用详情。 |
| CreatePrivateAccessApplication | 创建内网访问应用 | 创建当前阿里云账号下内网访问应用。 |
| DeletePrivateAccessApplication | 删除内网访问应用 | 删除当前阿里云账号下内网访问应用。 |
| UpdatePrivateAccessApplication | 修改内网访问应用 | 修改当前阿里云账号下内网访问应用。 |
Connector
| API | 标题 | API概述 |
|---|---|---|
| ListConnectors | Batch Query Connectors | Batch query connectors。 |
| AttachApplication2Connector | 挂载Connector的应用 | 挂载当前阿里云账号下Connector的内网访问应用。 |
| DetachApplication2Connector | 卸载Connector的应用 | 卸载当前阿里云账号下Connector的内网访问应用。 |
内网访问标签
| API | 标题 | API概述 |
|---|---|---|
| ListPrivateAccessTags | 批量查询内网访问标签 | 批量查询当前阿里云账号下所有内网访问标签的信息。 |
| ListApplicationsForPrivateAccessTag | 批量查询内网访问标签的应用 | 批量查询当前阿里云账号下内网访问标签的应用。 |
| ListPolicesForPrivateAccessTag | 批量查询内网访问标签的策略 | 批量查询当前阿里云账号下内网访问标签的策略。 |
| CreatePrivateAccessTag | 创建内网访问标签 | 创建当前阿里云账号下内网访问标签。 |
| DeletePrivateAccessTag | 删除内网访问标签 | 删除当前阿里云账号下内网访问标签。 |
内网访问策略
| API | 标题 | API概述 |
|---|---|---|
| ListPrivateAccessPolices | 批量查询内网访问策略 | 获取当前阿里云账号下所有内网访问策略的信息。 |
| ListUserGroupsForPrivateAccessPolicy | 批量查询内网访问策略的用户组 | 批量查询当前阿里云账号下内网访问策略的用户组。 |
| ListApplicationsForPrivateAccessPolicy | 批量查询内网访问策略的应用 | 批量查询当前阿里云账号下内网访问策略的应用。 |
| ListTagsForPrivateAccessPolicy | 批量查询内网访问策略的标签 | 批量查询当前阿里云账号下内网访问策略的标签。 |
| GetPrivateAccessPolicy | 查询内网访问策略详情 | 获取当前阿里云账号下指定内网访问策略的详情信息。 |
| CreatePrivateAccessPolicy | 创建内网访问策略 | 创建当前阿里云账号下内网访问策略。 |
| DeletePrivateAccessPolicy | 删除内网访问策略 | 删除当前阿里云账号下内网访问策略。 |
| UpdatePrivateAccessPolicy | 修改内网访问策略 | 修改当前阿里云账号下内网访问策略。 |
全球办公
| API | 标题 | API概述 |
|---|---|---|
| ListDynamicRoutes | 批量查询动态路由 | 获取当前阿里云账号下所有动态路由的信息。 |
| ListPrivateAccessApplicationsForDynamicRoute | 批量查询动态路由的应用 | 批量查询当前阿里云账号下动态路由的应用。 |
| ListPrivateAccessTagsForDynamicRoute | 批量查询动态路由的标签 | 批量查询当前阿里云账号下动态路由的标签。 |
| GetDynamicRoute | 查询动态路由详情 | 获取当前阿里云账号下指定动态路由的详情信息。 |
| ListDynamicRouteRegions | 批量查询动态路由已授权地域 | 批量查询当前阿里云账号下查询SASE的POP集群接入点支持地域。 |
| CreateDynamicRoute | 创建动态路由 | 创建当前阿里云账号下创建动态路由。 |
| UpdateDynamicRoute | 修改动态路由 | 修改当前阿里云账号下动态路由。 |
| DeleteDynamicRoute | 删除动态路由 | 删除当前阿里云账号下动态路由。 |
数字水印
| API | 标题 | API概述 |
|---|---|---|
| LookupWmInfoMapping | 查询水印信息映射关系 | 通过查询已创建的水印信息映射关系，根据数字格式的水印信息查找得到对应的字符串格式的水印信息。 |
| CreateWmInfoMapping | 创建水印信息映射关系 | 创建一条字符串格式的水印信息到数字格式的水印信息的映射关系。 |
| CreateWmBaseImage | 创建暗水印透明底图 | 获取网页水印、屏幕水印和App水印的暗水印透明底图。 |
| GetWmExtractTask | 查询水印提取任务详情 | 根据创建提取任务时获取的任务ID，查询水印提取任务结果。 |
| GetWmEmbedTask | 查询水印嵌入任务详情 | 使用创建水印嵌入任务得到的任务ID，查询嵌入任务结果。 |
| CreateWmExtractTask | 创建水印提取任务 | 创建数字水印提取任务。 |
| CreateWmEmbedTask | 创建水印嵌入任务 | 创建数字水印嵌入任务。 |
其他
| API | 标题 | API概述 |
|---|---|---|
| RevokeUserSession | 吊销用户登录会话 | 吊销用户登录会话。 |
| ListPopTrafficStatistics | 查询POP点带宽统计 | 查询SASE的POP节点带宽。 |
| DeleteOtpConfig | 删除员工OTP配置。 | 删除员工OTP配置。 |