简介
本文档提供关于网页审核的 API 概览和 SDK 示例代码。
注意:
COS Javascript SDK 版本需要大于等于 v1.3.1。
API | 操作描述 |
用于提交一个网页审核任务 | |
用于查询指定的网页审核任务 |
提交网页审核任务
功能说明
用于提交一个网页审核任务。
请求示例
// sdk的引入及初始化cos请参考 https://cloud.tencent.com/document/product/436/11459function postWebpageAuditing() {const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须Region: 'COS_REGION', // 存储桶所在地域,比如ap-beijing,必须};const host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';const key = 'webpage/auditing'; // 固定值const url = `https://${host}/${key}`;const body = COS.util.json2xml({Request: {Input: {Url: 'https://cloud.tencent.com/', // 网页文件的链接地址},Conf: {BizType: '',}}});cos.request({Method: 'POST', // 固定值,必须Url: url, // 请求的url,必须Key: key, // 固定值,必须ContentType: 'application/xml', // 固定值,必须Body: body // 请求体参数,必须},function(err, data){if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}});}postWebpageAuditing();
参数说明
cos.request 方法参数说明:
参数名称 | 描述 | 类型 | 是否必选 |
Method | 请求方法,固定值 | String | 是 |
Url | 请求url,固定值 | String | 是 |
Key | 固定值 | String | 是 |
ContentType | 固定值 | String | 是 |
Body | Container | 是 |
回调函数说明
function(err, data) { ... }
相关链接
查询网页审核任务结果
功能说明
用于查询网页审核任务执行情况和结果。
请求示例
// sdk的引入及初始化cos请参考 https://cloud.tencent.com/document/product/436/11459function getWebpageAuditingResult() {const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须Region: 'COS_REGION', // 存储桶所在地域,比如ap-beijing,必须};const jobId = 'shce868019aff611ecb1155254009a4xxx'; // jobId 可以通过提交网页审核任务返回const host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';const key = `webpage/auditing/${jobId}`; // 固定值,必须const url = `https://${host}/${key}`;cos.request({Method: 'GET', // 固定值,必须Url: url, // 请求的url,必须Key: key, // 固定值,必须},function(err, data){if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}});}getWebpageAuditingResult();
参数说明
cos.request 方法参数说明:
参数名称 | 描述 | 类型 | 是否必选 |
Method | 请求方法,固定值 | String | 是 |
Url | 请求url,固定值 | String | 是 |
Key | 固定值:webpage/auditing/要查询的jobId | String | 是 |
参数名称 | 描述 | 类型 | 是否必选 |
jobId | 需要查询的任务 ID | String | 是 |
回调函数说明
function(err, data) { ... }
参数名称 | 参数描述 | 类型 |
err | Object | |
- statusCode | 请求返回的 HTTP 状态码,例如 200、403、404 等 | Number |
- headers | 请求返回的头部信息 | Object |
data | 请求成功时返回的对象,如果请求发生错误,则为空 | Object |
- statusCode | 请求返回的 HTTP 状态码,例如 200、403、404 等 | Number |
- headers | 请求返回的头部信息 | Object |
- Response | Object |