公共參數指所有HTTP請求都包含的內容,具體包括公共請求頭和公共請求參數。
公共請求頭
下表描述的公共請求頭(Request Header)適用于通過URL發送HTTP POST請求調用內容安全檢測服務類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日期格式表示,例如, |
x-acs-version | String | 是 | 內容安全接口的版本號。取值: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 | 是 | 簽名方式。取值:
關于簽名方式的更多信息,請參見簽名機制。 |
x-acs-content-sm3 | String | 否 | 請求體的編碼值,根據請求體計算所得。 算法說明:將請求體內容當作字符串進行國密SM3加密得到bytes數組,然后將bytes數組轉換成16進制,即:encodeHexString(SM3Digest(body))。 |
Authorization | String | 是 | 認證方式,格式為 參數說明:
|
公共請求參數
下表描述的公共請求參數(Query Parameter)適用于所有通過URL發送HTTP POST請求調用內容安全檢測服務類API。
名稱 | 類型 | 是否必選 | 描述 |
clientInfo | String | 否 | 發起請求的客戶端信息。由ClientInfo結構體通過JSON序列化獲得,包括umid或imei等信息。具體結構描述,請參見ClientInfo。 |
名稱 | 類型 | 是否必選 | 描述 |
sdkVersion | String | 否 | SDK版本號。 通過SDK調用時需要提供該字段。更多信息,請參見SDK概覽。 |
cfgVersion | String | 否 | 配置信息版本。 通過SDK調用時需要提供該字段。更多信息,請參見SDK概覽。 |
userType | String | 否 | 用戶賬號的類型。取值:
|
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/json
到Content-Length: 191
:表示HTTP請求頭。其中,Accept: application/json
到Authorization: acs q23Q9K4PaGi12Wyk:adFff0FFO6sGcDbDNjRtso==
表示簽名時要用到的公共請求頭。{}
中的內容:表示JSON格式的請求體。請求體的結構取決于不同接口的定義,請參見對應的接口文檔。