內容安全URL風險檢測能力,幫助用戶識別第三方URL鏈接是否存在欺詐、色情、賭博等風險,守護平臺內容生態。本文介紹使用異步API接口進行URL風險檢測的方法。
接入指引
注冊阿里云賬號:立即注冊,按照操作提示完成賬號注冊。
開通內容安全按量付費:請確保您已開通服務,開通不收費,接口接入使用后系統會按使用量自動出賬,詳情請參見計費說明。您也可以購買按量抵扣資源包,資源包相較于后付費存在一定階梯抵扣,適合使用量級可預期和較大的用戶。
創建AccessKey:請確保您已通過RAM創建AccessKey,如果您使用的是子賬號AccessKey,您需要通過主賬號給子賬號賦予AliyunYundunGreenWebFullAccess權限,具體操作,請參見RAM授權。
開發接入:推薦使用SDK方式調用,具體方法請詳見URL風險檢測接入指南。
URL風險檢測異步服務包含以下2個接口:
UrlAsyncModeration:提交URL風險檢測任務
DescribeUrlModerationResult:獲取URL風險檢測結果
提交審核任務
使用說明
業務接口:UrlAsyncModeration
支持的地域及接入地址:
地域 | 外網接入地址 | 內網接入地址 | 支持服務 |
華東2(上海) | https://green-cip.cn-shanghai.aliyuncs.com | https://green-cip-vpc.cn-shanghai.aliyuncs.com | url_detection_pro |
計費信息:
該接口為收費接口。僅對HTTP狀態碼為200的請求進行計量計費,產生其他錯誤碼時不會計費。關于計費方式,請參見URL風險檢測介紹及計費說明。
返回結果:異步檢測任務不會實時返回檢測結果,您需要通過callback或者輪詢的方式獲取檢測結果。檢測結果最長保留3天。
callback獲取檢測結果:提交異步檢測任務時,在請求參數中傳入callback參數,用來自動接收檢測結果。
輪詢獲取檢測結果:提交異步檢測任務時,無需傳入callback參數;提交異步檢測任務后,調用結果查詢接口獲取檢測結果。異步檢測當前為排隊檢測,結果會在24小時內檢測完畢。
支持URL格式:
URL風險檢測服務支持符合以下格式的URL地址:http(s)://{IP或域名}{:端口}{/路徑}
說明URL地址可以沒有HTTP或HTTPS前綴
域名部分是數字、字母組成,英文點號分隔,一級域名2-6個字母
端口部分支持1-4個數字
路徑支持數字、字母、及常見字符,例如_!~*'().;?:@&=+$,%#-)等,不能有中文
如果輸入URL地址不符合該格式,會返回錯誤碼 400。
QPS限制
本接口的單用戶QPS限制為100次/秒。超過限制,API調用會被限流,這可能會影響您的業務,請合理調用。如果您業務量級較大或者有緊急擴容需求需要更大QPS,請聯系您的商務經理。
調試
在接入前,您也可以通過阿里云OpenAPI在線調試提交URL風險檢測任務的接口,查看調用示例代碼及SDK依賴信息,方便概覽接口的使用方法和參數。
在線調試能力是基于當前登錄賬號調用內容安全的API接口,因此調用量會計入賬號的收費用量中。
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
Service | String | 是 | url_detection_pro | 圖片檢測增強版支持的檢測服務。取值:
|
ServiceParameters | JSONString | 是 | 內容檢測對象的相關參數集。JSON字符串格式,關于每個字符串的描述,請參見表 1. ServiceParameters。 |
表 1. ServiceParameters
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
url | String | 是 | 待檢測的URL。 說明 請確保該URL符合URL格式要求。且一次請求請確保僅傳入1條URL。 | |
dataId | String | 否 | url123**** | 檢測對象對應的數據ID。 由大小寫英文字母、數字、下劃線(_)、短劃線(-)、英文句號(.)組成,不超過64個字符,可以用于唯一標識您的業務數據。 |
callback | String | 否 | http://www.aliyundoc.com | 檢測結果回調通知您的URL,支持使用HTTP和HTTPS協議的地址。該字段為空時,您必須定時輪詢檢測結果。 callback接口必須支持POST方法、UTF-8編碼的傳輸數據,以及表單參數ReqId,Checksum和Content。 內容安全按照以下規則和格式設置ReqId,Checksum和Content,調用您的callback接口返回檢測結果。
說明 您的服務端callback接口收到內容安全推送的結果后,如果返回的HTTP狀態碼為200,則表示接收成功,其他的HTTP狀態碼均視為接收失敗。接收失敗時,內容安全將最多重復推送16次檢測結果,直到接收成功。重復推送16次后仍未接收成功,則不再推送,建議您檢查callback接口的狀態。 |
seed | String | 否 | abc**** | 隨機字符串,該值用于回調通知請求中的簽名。 由英文字母、數字、下劃線(_)組成,不超過64個字符。由您自定義,用于在接收到內容安全的回調通知時校驗請求由阿里云內容安全服務發起。 說明 當使用callback時,該字段必須提供。 |
cryptType | String | 否 | SHA256 | 使用回調通知時(callback),設置對回調通知內容進行加密的算法。內容安全會將返回結果(由用戶uid + seed + content拼接的字符串)按照您設置的加密算法加密后,再發送到您的回調通知地址。取值: ●SHA256(默認):使用SHA256加密算法。 ●SM3:使用國密HMAC-SM3加密算法,返回十六進制的字符串,且字符串由小寫字母和數字組成。例如,abc經國密SM3加密后返回。 |
返回數據
名稱 | 類型 | 示例值 | 描述 | |
Code | Integer | 200 | 狀態碼。更多信息,請參見Code 說明。 | |
Msg | String | OK | 請求消息的響應消息。 | |
RequestId | String | ABCD1234-1234-1234-1234-123**** | 請求ID。 | |
Data | Object | 檢測結果。 | ||
ReqId | String | ABCD1234-1234-1234-1234-123**** | 請求ID。 | |
DataId | String | img123****** | 檢測對象對應的數據ID。 |
示例
請求示例
{
"Service": "url_detection_pro",
"ServiceParameters": {
"url": "http://bestwisewords.com/",
"dataId": "url123******"
}
}
返回示例
{
"Msg": "OK",
"Code": 200,
"RequestId": "ABCD1234-1234-1234-1234-1234XYZ",
"Data": {
"ReqId": "ABCD1234-1234-1234-1234-1234XYZ",
"DataId": "url123******"
}
}
獲取審核任務結果
接口說明
業務接口:DescribeUrlModerationResult,表示獲取URL風險檢測任務結果。
計費信息:該接口不計費。
查詢超時:建議您將查詢間隔設置為5分鐘(即在提交異步檢測任務5分鐘之后查詢結果),最長不能超出3天,否則結果將會自動刪除。
QPS限制
本接口的單用戶QPS限制為100次/秒。超過限制,API調用會被限流,這可能會影響您的業務,請合理調用。
調試
在接入前,您也可以通過阿里云OpenAPI在線調試獲取URL風險檢測任務結果的接口,查看調用示例代碼及SDK依賴信息,方便概覽接口的使用方法和參數。
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
reqId | String | 是 | 70ED13B0-BC22-576D-9CCF-1CC12FEAC477 | 請求ID。是指提交審核任務返回的RequestId字段。 |
返回數據
名稱 | 類型 | 示例值 | 描述 |
RequestId | String | ABCD1234-1234-1234-1234-123**** | 本次調用請求的ID,是由阿里云為該請求生成的唯一標識符,可用于排查和定位問題。 |
Data | Object | URL風險檢測結果。更多信息,請參見表 2.Data。 | |
Code | Integer | 200 | 狀態碼。更多信息,請參見Code說明。 |
Msg | String | OK | 本次請求的響應消息。 |
表 2.Data
名稱 | 類型 | 示例值 | 描述 |
Results | Array | URL檢測的風險標簽、置信分等參數結果。更多信息,請參見表 3.Result。 | |
DataId | String | img123****** | 檢測對象對應的數據ID。 說明 如果在檢測請求參數中傳入了dataId,則此處返回對應的dataId。 |
ExtraInfo | Object | 輔助參考信息。更多信息,請參見表 4.ExtraInfo。 |
表 3.Result
名稱 | 類型 | 示例值 | 描述 |
Label | String | sexual_url | URL目標地址經過檢測運算后返回的標簽。同一張URL可能會檢出多個標簽和分值。支持的標簽如下:
|
Confidence | Float | 81.22 | 置信分值,0到100分,保留到小數點后2位。 |
表 4.ExtraInfo
名稱 | 類型 | 示例值 | 描述 |
IcpType | String | 企業 | ICP備案類型。 |
IcpNo | String | ICP備123456789 | ICP備案號。 |
示例
請求示例
{
"ReqId": "ABCD1234-1234-1234-1234-123****"
}
返回示例
{
"Msg": "OK",
"Code": 200,
"Data": {
"DataId": "img123****",
"Result": [
{
"Label": "sexual_url",
"Confidence": 81.18
}
],
"ExtraInfo": {
"IcpType": "企業",
"IcpNo": "ICP備123456789"
}
},
"RequestId": "ABCD1234-1234-1234-1234-123****"
}
Code說明
以下為接口返回code的含義說明,系統僅對code返回為200的請求計量計費,其他code不會計費。
Code | 說明 |
200 | 請求正常。 |
280 | 任務檢測中。 |
400 | 請求參數為空。 |
401 | 請求參數錯誤。 |
402 | 請求參數長度不符合接口規定,請檢查并修改。 |
403 | 請求超過QPS限制,請檢查并調整并發。 |
405 | 異步檢測超時,建議重試。 |
408 | 該賬號無權限調用該接口,可能是賬號未開通或者已欠費,或者調用賬號未被授權訪問。 |
500 | 系統異常。 |