全部產品
Search
文件中心

Content Moderation:公用參數

更新時間:Jul 06, 2024

公用參數指所有HTTP請求都包含的內容,具體包括公用要求標頭和公用請求參數。

公用要求標頭

下表描述的公用要求標頭(Request Header)適用於通過URL發送HTTP POST請求調用Alibaba Content Security Service檢測服務類API。

名稱

類型

是否必選

描述

Accept

String

接受的返回結果的類型。目前只支援JSON類型,取值:application/json

Content-Type

String

當前請求體(Request Body)的資料類型。目前只支援JSON類型,取值:application/json

Content-MD5

String

請求體的編碼值,根據請求體計算所得。

演算法說明:將請求體內容當作字串進行MD5編碼(返回二進位格式),然後進行Base64編碼。

說明

當密碼編譯演算法選擇HMAC-SM3時,該欄位可以不填寫;當密碼編譯演算法選擇HMAC-SHA1(預設)時,該欄位必填。

Date

String

請求的時間。使用GMT日期格式表示,例如,Tue, 17 Jan 2017 10:16:36 GMT

x-acs-version

String

Alibaba Content Security Service介面的版本號碼。取值:2018-05-09

重要

2018-05-09之前的版本已經下線,如果使用舊的版本號碼會返回HttpCode:400 , ErrorCode:InvalidAction.NotFound報錯,請更換為2018-05-09版本號碼。

x-acs-signature-nonce

String

簽名唯一隨機數。用於防止網路重放攻擊,建議您每一次請求都使用不同的隨機數。

x-acs-signature-version

String

簽名演算法版本。取值:1.0

x-acs-signature-method

String

簽名方式。取值:

  • HMAC-SHA1(預設)

  • HMAC-SM3

關於簽名方式的更多資訊,請參見簽名機制

x-acs-content-sm3

String

請求體的編碼值,根據請求體計算所得。

演算法說明:將請求體內容當作字串進行國密SM3加密得到bytes數組,然後將bytes數群組轉換成16進位,即:encodeHexString(SM3Digest(body))。

Authorization

String

認證方式,格式為"acs" + " " + AccessKeyId + ":" + signature

參數說明:

  • AccessKeyId:表示通過阿里雲控制台申請獲得的存取金鑰AccessKey ID。關於AccessKey ID的擷取方式,請參見建立AccessKey

  • signature:表示請求籤名。關於請求籤名的計算方法,請參見簽名機制

公用請求參數

下表描述的公用請求參數(Query Parameter)適用於所有通過URL發送HTTP POST請求調用Alibaba Content Security Service檢測服務類API。

名稱

類型

是否必選

描述

clientInfo

String

發起請求的用戶端資訊。由ClientInfo結構體通過JSON序列化獲得,包括umid或imei等資訊。具體結構描述,請參見ClientInfo

表 1. ClientInfo

名稱

類型

是否必選

描述

sdkVersion

String

SDK版本號碼。

通過SDK調用時需要提供該欄位。更多資訊,請參見SDK概覽

cfgVersion

String

配置資訊版本。

通過SDK調用時需要提供該欄位。更多資訊,請參見SDK概覽

userType

String

使用者帳號的類型。取值:

  • taobao:表示淘寶帳號。

  • others:表示其他帳號體系的帳號。

userId

String

您業務系統中使用者的唯一標識。

強烈建議您填寫該值用於分析使用者違規行為。

userNick

String

使用者暱稱。

imei

String

硬體裝置碼。

imsi

String

電訊廠商裝置碼。

umid

String

裝置指紋。

ip

String

用於標識您業務系統中使用者的公網IP地址。

如果請求是從裝置端發起的,該欄位通常不填寫。如果是從後台發起的,該IP為使用者的登入IP或者裝置的公網IP。

建議您填寫該IP用於分析使用者違規行為。如果未在請求中填寫,服務端會嘗試從連結或者HTTP要求標頭中擷取該IP。

os

String

裝置的作業系統類型,例如Android 6.0

channel

String

渠道號。

hostAppName

String

宿主應用程式名稱。

hostPackage

String

宿主應用程式套件名。

hostVersion

String

宿主應用版本。

請求樣本

POST /green/image/scan?clientInfo=%7b%22userId%22%3a%22120234234%22%2c%22userNick%22%3a%22Mike%22%2c%22userType%22%3a%22others%22%7d HTTP/1.1
Accept: application/json
Content-Type: application/json
Content-MD5: C+5Y0crpO4sYgC2DNjycug==
Date: Tue, 15 May 2018 10:16:36 GMT
x-acs-version: 2018-05-09
x-acs-signature-nonce: adfkjfaHKslkjf
x-acs-signature-version: 1.0
x-acs-signature-method: HMAC-SHA1
Authorization: acs q23Q9K4PaGi12Wyk:adFff0FFO6sGcDbDNjRtso==
Host: green.cn-shanghai.aliyuncs.com/
Content-Length: 191
{
    "scenes": [
        "porn"
    ],
    "tasks": [
        {
            "dataId": "test2NInmO$tAON6qYUrtCRgLo-1mwxdi",
            "url": "https://img.alicdn.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.png"
        }
    ]
}

參數說明:

  • POST:表示要求方法。

  • /green/image/scan:表示請求路徑。

  • clientInfo=%7b%22userId%22%3a%22120234234%22%2c%22userNick%22%3a%22Mike%22%2c%22userType%22%3a%22others%22%7d:表示經過編碼後的公用請求參數。

  • Accept: application/jsonContent-Length: 191:表示HTTP要求標頭。其中,Accept: application/jsonAuthorization: acs q23Q9K4PaGi12Wyk:adFff0FFO6sGcDbDNjRtso==表示簽名時要用到的公用要求標頭。

  • {}中的內容:表示JSON格式的請求體。請求體的結構取決於不同介面的定義,請參見對應的介面文檔