共通パラメーターは、すべての HTTP リクエストに含める必要があります。共通パラメーターは、共通リクエストヘッダーと共通リクエストパラメーターで構成されます。
共通リクエストヘッダー
次の表は、URL を使用して HTTP POST リクエストを送信し、コンテンツモデレーション API を呼び出す際に使用する必要がある共通リクエストヘッダーについて説明しています。
ヘッダー | タイプ | 必須 | 説明 |
Accept | String | はい | 受け入れ可能なレスポンスのデータ型。JSON タイプのみがサポートされています。[application/json] に設定します。 |
Content-Type | String | はい | リクエスト本文のデータ型。JSON タイプのみがサポートされています。[application/json] に設定します。 |
Content-MD5 | String | いいえ | リクエスト本文に基づいて計算されたエンコード値。 値を取得するには、リクエスト本文のコンテンツを文字列として使用し、文字列に MD5 アルゴリズムを適用してバイナリデータの出力を取得し、Base64 アルゴリズムに基づいて出力をエンコードします。 説明 [HMAC-SM3] 暗号化アルゴリズムを使用する場合は、このヘッダーはオプションです。[HMAC-SHA1] 暗号化アルゴリズムを使用する場合は、このヘッダーが必要です。デフォルトでは、HMAC-SHA1 暗号化アルゴリズムが使用されます。 |
Date | String | はい | リクエストが送信された時刻。このヘッダーは GMT 形式を使用します。例:Tue, 17 Jan 2017 10:16:36 GMT。 |
x-acs-version | String | はい | コンテンツモデレーション API のバージョン。[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 暗号化アルゴリズムを適用してバイト配列を取得し、配列を 16 進形式に変換します。これは encodeHexString(SM3Digest(body)) メソッドです。 |
Authorization | String | はい | 認証方式。 パラメーターの説明:
|
共通リクエストパラメーター
次の表は、URL を使用して HTTP POST リクエストを送信し、コンテンツモデレーション API を呼び出す際に使用できる共通リクエストパラメーターについて説明しています。
パラメーター | タイプ | 必須 | 説明 |
clientInfo | String | いいえ | リクエストを送信するクライアントに関する情報。この情報は、JSON 形式の ClientInfo 構造体からシリアル化されます。情報には、クライアントの一意のマシン識別子(UMID)と国際モバイル機器識別子(IMEI)が含まれます。詳細については、「ClientInfo」をご参照ください。 |
パラメーター | タイプ | 必須 | 説明 |
sdkVersion | String | いいえ | コンテンツモデレーション SDK のバージョン。 このパラメーターは、コンテンツモデレーション SDK を使用して操作が呼び出される場合に必須です。詳細については、「SDK の概要」をご参照ください。 |
cfgVersion | String | いいえ | 構成のバージョン。 このパラメーターは、コンテンツモデレーション SDK を使用して操作が呼び出される場合に必須です。詳細については、「SDK の概要」をご参照ください。 |
userType | String | いいえ | ユーザーアカウントのタイプ。有効な値:
|
userId | String | いいえ | ビジネスシステム内のユーザーの一意の ID。 このパラメーターは、特定のユーザーの潜在的な違反行動を検出するのに役立ちます。このパラメーターを設定することをお勧めします。 |
userNick | String | いいえ | ユーザーのニックネーム。 |
imei | String | いいえ | デバイスの IMEI。 |
imsi | String | いいえ | デバイスの国際モバイル加入者識別子(IMSI)。 |
umid | String | いいえ | デバイスの UMID。 |
ip | String | いいえ | ビジネスシステム内のユーザーのパブリック IP アドレス。 リクエストがデバイスから開始された場合、このパラメーターは空のままにすることができます。リクエストがサーバーから開始された場合、このパラメーターはユーザーのログオン IP アドレスまたはデバイスのパブリック IP アドレスに設定されます。 ユーザーの違反行動を分析するために、このパラメーターを設定することをお勧めします。このパラメーターがリクエストで指定されていない場合、サーバーはリクエスト URL または 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 形式のリクエスト本文です。リクエスト本文の構造は、さまざまな API 操作の定義によって異なります。詳細については、「機能別の操作一覧」をご参照ください。