API标准及多语言预置SDK
本产品（Green/2017-08-23）的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概述 |
| AuditItemSubmit | 提交审核作业 | 提交复审的结果。 |
| CreatCustomOcrTemplate | 创建自定义ocr模板 | 创建ocr模板。 |
| CreateAuditCallback | 创建审核回调 | 创建回调方式、回调地址、事件类型 |
| CreateBizType | 创建业务类型 | 创建业务场景。 |
| CreateCallback | 创建回调 | 创建消息通知 |
| CreateImageLib | 创建自定义图库 | 创建图库。 |
| CreateKeyword | 向指定文本库中添加文本 | 新增关键词。 |
| CreateKeywordLib | 创建自定义文本库 | 创建文本库 |
| CreateOssStockTask | 创建oss存量任务 | 创建存量扫描任务。 |
| CreateWebsiteIndexPageBaseline | 创建网站索引页基线 | 创建站点首页基线 |
| DeleteAuditCallback | 删除审核回调 | 删除自助审核消息通知 |
| DeleteBizType | 删除业务类型 | 删除业务场景 |
| DeleteCallback | 删除回调 | 删除消息通知 |
| DeleteCustomOcrTemplate | 删除自定义ocr模板 | 删除ocr模板 |
| DeleteImageFromLib | 删除图库中的指定图片 | 从图库删除图片 |
| DeleteImageLib | 删除自定义图片库 | 删除图库 |
| DeleteKeyword | 删除文本库中的文本 | 删除关键词 |
| DeleteKeywordLib | 删除自定义文本库 | 删除文本库 |
| DescribeAppInfo | 查询 APP 信息 | 查询一个应用的信息。 |
| DescribeAuditCallback | 获取审核回调 | 查询回调配置。 |
| DescribeAuditCallbackList | 获取审核回调列表 | 查询指定查询条件下的回调配置列表。 |
| DescribeAuditContent | 获取审核内容 | 自助审核列表 |
| DescribeAuditContentItem | 获取审核内容详细结果 | 查询审核结果详情。 |
| DescribeAuditRange | 获取审核范围 | 查询审核范围。 |
| DescribeAuditSetting | 获取审核设置 | 查询审核配置。 |
| DescribeBizTypeAuditRange | 获取业务类型审核范围 | 流入自助审核的数据类型 |
| DescribeBizTypeImageLib | 获取业务类型图像库 | 自定义场景关联图库列表查询 |
| DescribeBizTypeResultBackupSetting | 获取业务类型备份设置 | 获取证据转存设置 |
| DescribeBizTypes | 获取BizType列表 | 查询业务场景Biztype列表。 |
| DescribeBizTypeSetting | 获取业务类型设置 | 查询业务场景机审标准 |
| DescribeBizTypeTemplates | 获取业务类型模版 | OSS扫描用户可选模板列表 |
| DescribeBizTypeTextLib | 获取业务类型文本库 | 业务场景关联文本库 |
| DescribeCallbackBind | 获取回调绑定信息 | 获取消息通知配置 |
| DescribeCallbackList | 获取回调列表 | 获取消息通知列表 |
| DescribeCloudMonitorServices | 获取云监控服务 | 获取并发检测服务 |
| DescribeCustomOcrTemplate | 获取自定义ocr模板 | 查询用户OCR模板 |
| DescribeImageFromLib | 获取自定义图片库中已添加的图片列表 | 库维度图片列表 |
| DescribeImageLib | 查询自定义图库信息列表 | 查询自定义图库信息列表。 |
| DescribeImageUploadInfo | 获取图片上传信息 | 获取图片上传设置 |
| DescribeKeyword | 搜索指定文本库中的文本 | 查询关键词列表 |
| DescribeKeywordLib | 获取文本库列表 | 查询文本库列表 |
| DescribeNotificationSetting | 获取通知配置 | 查询站点检测消息通知设置 |
| DescribeOpenApiMonitorAlarmSetting | 获取开放api监控报警设置 | 实时监控报警设置 |
| DescribeOpenApiMonitorData | 获取api监控数据 | 机审实时监控 |
| DescribeOpenApiRcpStats | 获取开放API调用统计 | 人审数据统计 |
| DescribeOpenApiUsage | 获取用量统计 | 机审数据统计。 |
| DescribeOssCallbackSetting | 获取 Oss 回调设置 | 查询oss增量扫描回调配置。 |
| DescribeOssConfiguration | Describe Oss Task Configuration | 获取oss检测配置 |
| DescribeOssIncrementCheckSetting | 获取oss增量检查设置 | OSS增量扫描设置 |
| DescribeOssIncrementOverview | 获取 OSS 增量概述 | 查询待开票对象信息。 |
| DescribeOssIncrementStats | 获取oss增量统计 | Oss增量扫描数据统计 |
| DescribeOssResultItems | 获取OSS违规检测的检测结果数据 | Oss扫描结果查询 |
| DescribeOssStockScanTasks | 获取oss存量扫描任务 | Oss存量扫描任务列表查询 |
| DescribeOssStockScanTaskStatData | 获取oss存量状态数据 | Oss存量扫描结果数据 |
| DescribeOssStockScanUserStatus | 获取oss用户状态 | OSS存量扫描用户状态 |
| DescribeOssStockStatus | 获取oss库存状态 | 获取oss存量检测状态 |
| DescribeOssStockTaskSetting | 获取oss库存任务设置 | 获取存量扫描任务配置 |
| DescribeUploadInfo | 获取图片信息 | 文本库上传信息 |
| DescribeUsageBill | 获取使用账单 | 查询用户的计费类型 |
| DescribeUserBizTypes | 获取用户业务类型 | 获取用户业务场景 |
| DescribeUserOssBuckets | 获取用户bucket | 获取用户oss桶列表 |
| DescribeUserStatus | 获取用户状态信息 | 获取用户状态 |
| DescribeViewContent | 获取视图内容 | 获取检测结果列表 |
| DescribeWebsiteIndexPageBaseline | 获取网站索引页基线 | 获取站点首页基线 |
| DescribeWebsiteInstance | 获取网站实例 | 查询站点检测实例 |
| DescribeWebsiteInstanceId | 获取网站实例 | 获取websiteinstanceid。 |
| DescribeWebsiteInstanceKeyUrl | 获取网站实例密钥URL | 获取站点实例url |
| DescribeWebsiteScanResult | 获取网站扫描结果 | 查询站点扫描结果 |
| DescribeWebsiteStat | 获取网站状态 | 获取站点检测状态 |
| DescribeWebsiteVerifyInfo | 获取网站验证信息 | 获取网站验证信息 |
| ExportKeywords | 导出关键词 | 导出关键词 |
| ExportOpenApiRcpStats | 导出开放API调用统计 | 导出OpenAPI调用统计 |
| ExportOpenApiUsage | 导出开放api用量 | 导出基线检查、资源占用、负载均衡状态等检测结果 |
| ExportOssResult | 以文件的形式导出OSS违规检测结果 | 导出Oss扫描结果 |
| GetAuditItemDetail | 获取审核内容详情 | 机审结果详情 |
| GetAuditItemList | 获取审核内容列表 | 人审结果列表 |
| GetAuditUserConf | 获取审核状态 | 人审等控制台配置信息 |
| ImportKeywords | 导入关键词 | 导入关键词 |
| MarkAuditContent | 标记审核内容 | 自助审核结果打标记。 |
| MarkOssResult | 对OSS违规检测结果进行审核和标记 | 标记oss检测结果 |
| ModifyAuditCallback | 修改审核回调 | 修改人审回调通知 |
| StopOssIncrementCheck | 停止oss增量检查 | 停止增量扫描任务。 |
| UpdateAuditCallback | 更新审核回调 | 更新回调配置信息。 |
| UpdateAuditRange | 更新审核范围 | 更新审核范围 |
| UpdateBizType | 更新业务类型 | 编辑业务场景信息 |
| UpdateBizTypeAuditRange | 更新业务类型审批 | 修改流入自助审核的数据类型 |
| UpdateBizTypeImageLib | 更新业务类型图像库 | 自定义场景保存关联图库配置 |
| UpdateBizTypeResultBackupSetting | 更新业务类型备份设置 | 修改证据转存设置 |
| UpdateBizTypeSetting | 更新业务类型设置 | 修改业务场景机审标准 |
| UpdateBizTypeTextLib | 更新业务类型文本库 | 修改业务场景关联文本库 |
| UpdateCallback | 更新回调 | 更新消息回调 |
| UpdateCallbackBind | 更新审核回调绑定 | 更新审核回调（Audit Callback）与业务场景（BizType）的绑定关系；BizType 有效值通过 DescribeUserBizTypes 获取，Name 有效值通过 DescribeAuditCallbackList 获取 |
| UpdateCustomOcrTemplate | 更新自定义ocr模板 | 编辑ocr模板 |
| UpdateImageLib | 更新图片库名称及参数 | 更新自定义图片库的名称及适用的bizTypes参数。 |
| UpdateKeywordLib | 更新自定义文本库信息 | 编辑词库 |
| UpdateNotificationSetting | 更新通知设置 | 更新通知设置。 |
| UpdateOssIncrementCheckSetting | 更新oss增量检查设置 | 更新增量扫描配置 |
| UpdateOssStockTask | 更新oss检测存量任务 | 更新oss存量任务 |
| UpdateWebsiteInstance | 更新网站实例 | 更新实例 |
| UpdateWebsiteInstanceKeyUrl | 更新网站实例 KeyUrl | 更新网站实例url |
| UpdateWebsiteInstanceStatus | 更新网站实例状态 | 更新实例状态，即解绑定，停止、运行等状态 |
| UploadImageToLib | 向自定义库中添加图片元信息 | 上传图片到图库 |
| VerifyCustomOcrTemplate | 验证自定义ocr模板 | ocr模板测试 |
| VerifyWebsiteInstance | 验证网站实例 | 验证域名所有权。 |
该文章对您有帮助吗？