URL风险同步检测API

URL风险检测能力,帮助用户识别第三方URL链接是否存在欺诈、色情、赌博等风险,守护平台内容生态。本文介绍使用同步API接口进行URL风险检测的方法。

接入指引

  1. 注册阿里云账号:立即注册,按照操作提示完成账号注册。

  2. 开通内容安全按量付费:请确保您已开通服务,开通不收费,接口接入使用后系统会按使用量自动出账,详情请参见URL风险检测介绍及计费说明。您也可以购买按量抵扣资源包,资源包相较于后付费存在一定阶梯抵扣,适合使用量级可预期和较大的用户。

  3. 创建AccessKey:请确保您已通过RAM创建AccessKey,如果您使用的是子账号AccessKey,您需要通过主账号给子账号赋予AliyunYundunGreenWebFullAccess权限,具体操作,请参见RAM授权

  4. 开发接入:推荐使用SDK方式调用,具体方法请详见接入指南

使用说明

您可以调用该接口创建文本内容检测任务。关于如何构造HTTP请求,请参见HTTPS原生调用;您也可以直接选用已构造好的HTTP请求,更多信息,请参见接入指南

  • 业务接口:https://green-cip.{region}.aliyuncs.com

  • 支持的地域及接入地址

    地域

    外网接入地址

    内网接入地址

    华东2(上海)

    https://green-cip.cn-shanghai.aliyuncs.com

    https://green-cip-vpc.cn-shanghai.aliyuncs.com

    华东1(杭州)

    https://green-cip.cn-hangzhou.aliyuncs.com

    https://green-cip-vpc.cn-hangzhou.aliyuncs.com

    华北2(北京)

    https://green-cip.cn-beijing.aliyuncs.com

    https://green-cip-vpc.cn-beijing.aliyuncs.com

    华南1(深圳)

    https://green-cip.cn-shenzhen.aliyuncs.com

    暂无

    西南1(成都)

    https://green-cip.cn-chengdu.aliyuncs.com

    暂无

  • 计费信息

    该接口为收费接口。仅对HTTP状态码为200的请求进行计量计费,产生其他错误码时不会计费。关于计费方式,请参见URL风险检测介绍及计费说明

  • 支持URL格式

    URL风险检测服务支持符合以下格式的URL地址:http(s)://{IP或域名}{:端口}{/路径}

    说明
    1. URL地址可以没有HTTP或HTTPS前缀

    2. 域名部分是数字、字母组成,英文点号分隔,一级域名2-6个字母

    3. 端口部分支持1-4个数字

    4. 路径支持数字、字母、及常见字符,例如_!~*'().;?:@&=+$,%#-)等,不能有中文

    如果输入URL地址不符合该格式,会返回错误码 BAD_REQUEST(400)。

QPS限制

本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。

调试

在接入前,您也可以通过阿里云OpenAPI在线调试文本审核增强版的接口,查看调用示例代码及SDK依赖信息,方便概览接口的使用方法和参数。

重要

在线调试能力是基于当前登录账号调用内容安全的API接口,因此调用量会计入账号的收费用量中。URL风险同步检测服务在文本检测增强版的接口传入对应的Service参数即可测试。

请求参数

名称

类型

是否必须

示例值

描述

Service

String

url_detection

审核服务类型。取值:

  • url_detection:URL风险链接检测

ServiceParameters

JSONString

审核服务需要的参数集。JSON字符串格式,关于每个字符串的描述见下表。

表 1.ServiceParameters

名称

类型

是否必须

示例值

描述

content

String

检测内容

审核的URL内容,限定在600字符以内。

accountId

String

10123****

账户ID,标识一个账户的唯一ID。

deviceToken

String

MzQvo1d7scyZ3tl_RcJ******

通过风险控制SDK获取到的设备令牌。

返回参数

名称

类型

示例值

描述

Code

Integer

200

状态码。更多信息,请参见Code说明

Data

JSONObject

{"labels":"sexuality","reason":"..."}

审核结果数据。更多信息,请参见表 2.Data

Message

String

OK

请求消息的响应消息。

RequestId

String

AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****

请求ID。

表 2.Data

名称

类型

示例值

描述

labels

String

sexuality

标签,多个标签用英文逗号(,)分隔。包括:

  • sexual_url:疑似色情网站

  • gambling_url:疑似赌博网站

  • phishing_url:疑似钓鱼网站

  • other_risk_url:疑似欺诈和其他风险

  • unmarked_url:未被风险标记的或正常网站

reason

String

{\"icpType\":\"企业\",\"icpNo\":\"ICP备123456789\",\"score\":\"90\"}

更多信息的JSON字符串。包含以下字段:

  • icpType:ICP备案类型

  • icpNo:ICP备案号

  • score:风险分数

示例

请求示例

{
    "Service": "url_detection",
    "ServiceParameters": "{\"content\":\"http://aliyun.com/abc\",\"accountId\":\"10123****\"}"
}

返回示例

{
    "Code": 200,
    "Data": {
        "Labels": "unmarked_url",
        "Reason": "{\"icpType\":\"企业\",\"icpNo\":\"ICP123XXXX789\",\"score\":\"60\"}"
    },
    "Message": "OK",
    "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****"
}

Code说明

以下为接口返回code的含义说明,系统仅对code返回为200的请求计量计费,其他code不会计费。

Code

Message

说明

200

OK

请求成功。

400

BAD_REQUEST

请求有误。可能是请求参数不正确导致,请仔细检查请求参数。

407

NOT_SUPPORT

无法识别或不支持该语种类型。

408

PERMISSION_DENY

可能是您的账号未授权、账号欠费、账号未开通、账号被禁等。

500

GENERAL_ERROR

错误。可能是服务端临时出错。建议重试,若持续返回该错误码,请通过在线服务联系我们。

581

TIMEOUT

超时。建议重试,若持续返回该错误码,请通过在线服务联系我们。

588

EXCEED_QUOTA

请求频率超出配额。