API标准及多语言预置SDK
本产品(safconsole/2025-05-21)的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。
API目录
|
API |
标题 |
API概述 |
| ApplyBastionAccount | 申请堡垒机账号 | 申请堡垒机账号。 |
| AssociatePocTask | 关联POC回溯任务 | 关联POC回溯任务。 |
| CompleteModelingProject | 完成项目 | 完成项目。 |
| CreateCustomerModuleBasicInfo | 模型基本信息保存 | 创建模型基本信息。 |
| CreateCustomerModuleMetaInfo | 特征信息保存 | 特征信息保存。 |
| CreateCustomerModuleOutputInfo | 出参信息保存 | 出参信息保存。 |
| CreateModelingProject | 创建安全建模项目 | 创建安全建模项目。 |
| DeleteModel | 删除 | 删除。 |
| DeployModelFile | 部署安全建模生成的模型 | 部署安全建模生成的模型。 |
| DescribeCustomerModuleBasicInfo | 查询模型基本信息 | 查询模型基本信息。 |
| DescribeCustomerModuleMetaInfo | 查询模型特征信息 | 查询模型特征信息。 |
| DescribeCustomerModuleOutputInfo | 查询模型输出信息 | 查询模型输出信息。 |
| DescribeFeatureOption | 根据特征模板选择获取特征对应下拉选项 | 根据特征模板选择获取特征对应下拉选项。 |
| DescribeFeatureTemplateList | 特征模板查询 | 特征模板查询。 |
| DescribeFileDownloadUrl | 获取文件下载地址 | 获取文件下载地址。 |
| DescribeModelFeature | 特征自动渲染信息 | 特征自动渲染信息。 |
| DescribeModelingProjectDetail | 安全建模项目详情 | 安全建模项目详情。 |
| DescribeModelingProjectList | 安全环境建模项目列表 | 安全环境建模项目列表。 |
| DescribeModelOssToken | 获取oss上传凭证 | 获取oss上传凭证。 |
| DescribeModuleServiceExist | 是否存在service查询 | 是否存在service查询。 |
| DescribeModuleStatus | 状态查询 | 状态查询 。 |
| DescribePocTaskList | 查询POC回溯列表 | 查询POC回溯列表。 |
| DescribeSafRmmpOrder | 查询订单权限 | 查询订单权限。 |
| DescribeServiceAndScene | 查询模型对应scene和service | 查询模型对应scene和service。 |
| DescribeUserModelList | 查询用户模型列表 | 查询用户模型列表。 |
| DuplicateModel | 复制模型 | 复制模型。 |
| EditModel | 模型退回编辑 | 模型退回编辑。 |
| GetBastionHostCertification | 获取登录初始密码 | 获取登录初始密码。 |
| IterateModel | 迭代模型 | 迭代模型。 |
| OfflineModel | 下线模型 | 下线模型。 |
| OnlineModel | 上线模型 | 上线模型。 |
| ParseExpressionParameters | 测试表达式解析 | 测试表达式解析。 |
| PrepublishModel | 提交测试环境 | 提交测试环境。 |
| RequestModelFileSync | 申请同步模型文件 | 申请同步模型文件。 |
| RollbackModel | 回滚 | 回滚。 |
| TestModel | 模型提交测试 | 模型提交测试。 |
| TestPreModel | 测试环境验证 | 测试环境验证。 |
| TestProcessExpression | 分数处理表达式测试 | 分数处理表达式测试。 |
| UpdateModuleBasicInfo | 模型基本信息更新 | 模型基本信息更新。 |
| ValidateModelFile | 模型验证 | 模型验证。 |
| ValidateTestFile | 测试模型验证 | 测试模型验证。 |
该文章对您有帮助吗?