內容檢測API支持通過扮演RAM角色的臨時身份憑證(STS Token)的方式進行調用。使用STS Token調用內容檢測API之前,您需要先調用AssumeRole接口,獲取扮演RAM角色的STS Token。本文介紹如何獲取STS Token和如何通過Token調用內容安全API。
STS Token方式調用可以保護賬號AccessKey信息,相比AccessKey方式更具有隱私性。
使用限制
只支持使用RAM用戶(子賬號)或RAM角色調用,不支持使用阿里云賬號(主賬號)調用。
前提條件
已為RAM用戶或RAM角色授予STS的管理權限(AliyunSTSAssumeRoleAccess)。具體操作,請參見為RAM用戶授權、為RAM角色授權。
步驟一:獲取STS Token
關于如何獲取STS Token,請參見AssumeRole - 獲取扮演角色的臨時身份憑證。
獲取STS Token代碼示例
from aliyunsdkcore.client import AcsClient
from aliyunsdkcore.request import CommonRequest
# 注意:此處實例化的client盡可能重復使用,提升檢測性能。避免重復建立連接。
# 常見獲取環境變量方式:
# 獲取RAM用戶AccessKey ID:os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID']
# 獲取RAM用戶AccessKey Secret:os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
client = AcsClient("建議從環境變量中獲取RAM用戶AccessKey ID", "建議從環境變量中獲取RAM用戶AccessKey Secret", "cn-shanghai")
request = CommonRequest()
request.set_accept_format('json')
request.set_domain('sts.aliyuncs.com')
request.set_method('POST')
request.set_protocol_type('https') # https | http
request.set_version('2015-04-01')
request.set_action_name('AssumeRole')
request.add_query_param("RoleArn", "acs:ram::174*************:role/ali**")
request.add_query_param("RoleSessionName", "alink")
response = client.do_action_with_exception(request)
print(str(response, encoding='utf-8'))
正常返回示例
{
"RequestId": "1*******-1111-5548-1111-6011111111D0",
"AssumedRoleUser":
{
"Arn": "acs:ram::17****************:role/alink/alink",
"AssumedRoleId": "3***************3:alink"
},
"Credentials":
{
"SecurityToken": "CAIS6Q******************wFnzm6aq/om6e49",
"AccessKeyId": "STS.NTu***************hh",
"AccessKeySecret": "FNQXp********************KCaZmpnA8fuyL",
"Expiration": "2022-12-13T04:43:09Z"
}
}
上面返回示例中Credentials字段包含了調用內容安全API所需的參數,其中Expiration為Token到期失效時間(UTC時間),需要在有效期內使用。
步驟二:通過STS Token調用內容安全API
以下以文本審核1.0版、增強版為例,為您展示通過STS Token調用內容安全API的代碼示例。
文本審核1.0版接口示例
from aliyunsdkcore.client import AcsClient
from aliyunsdkcore.profile import region_provider
from aliyunsdkcore.auth.credentials import StsTokenCredential// 該方法的入參為STS Token獲取的參數。
from aliyunsdkgreen.request.v20180509 import TextScanRequest
import uuid
import json
sts_token_credential = StsTokenCredential("Credentials_AccessKeyId", "Credentials_AccessKeySecret", "Credentials_SecurityToken")
acs_client = AcsClient(region_id='cn-shanghai', credential=sts_token_credential)
region_provider.modify_point('Green', 'cn-shanghai', 'green.cn-shanghai.aliyuncs.com')
# 每次請求時需要新建request,請勿復用request對象。
request = TextScanRequest.TextScanRequest()
request.set_accept_format('JSON')
task1 = {"dataId": str(uuid.uuid1()),
"content": "textContentToBeModerated",
}
# 文本反垃圾檢測場景的場景參數是antispam。
request.set_content(bytearray(json.dumps({"tasks": [task1], "scenes": ["antispam"]}), "utf-8"))
response = acs_client.do_action_with_exception(request)
print(response)
result = json.loads(response)
if 200 == result["code"]:
taskResults = result["data"]
for taskResult in taskResults:
if (200 == taskResult["code"]):
sceneResults = taskResult["results"]
for sceneResult in sceneResults:
scene = sceneResult["scene"]
suggestion = sceneResult["suggestion"]
# 根據scene和suggestion設置后續操作。
文本審核增強版接口示例
from aliyunsdkcore.client import AcsClient
from aliyunsdkcore.auth.credentials import StsTokenCredential
from aliyunsdkcore.request import CommonRequest
sts_token_credential = StsTokenCredential("Credentials_AccessKeyId", "Credentials_AccessKeySecret", "Credentials_SecurityToken")
client = AcsClient(region_id='cn-shanghai', credential=sts_token_credential)
request = CommonRequest()
request.set_accept_format('json')
request.set_method('POST')
request.set_protocol_type('https') # https | http
request.set_domain('green-cip.cn-shanghai.aliyuncs.com')
request.set_version('2022-03-02')
request.set_action_name('TextModeration')
# 審核服務類型,包括:
# nickname_detection:用戶昵稱
# chat_detection:聊天互動
# comment_detection:動態評論
request.add_query_param("Service", "nickname_detection")
request.add_query_param("ServiceParameters", {'content': '測試文本', 'accountId': "user123"})
response = client.do_action_with_exception(request)
print(str(response, encoding='utf-8'))
如何解決報錯:You are not authorized to do this action. You should be authorized by RAM?
未對RAM用戶或RAM角色授予STS的管理權限,會顯示該錯誤信息。造成該問題的原因和解決方法如下:
該調用者缺少允許STS扮演角色的權限策略。您可以為該RAM用戶或RAM角色添加系統策略(AliyunSTSAssumeRoleAccess)或自定義策略。具體操作,請參見能否指定RAM用戶具體可以扮演哪個RAM角色?、為RAM用戶授權。
RAM角色的信任策略不包含調用者,即RAM角色不允許該調用者扮演。您可以為RAM角色添加允許扮演的信任策略。具體操作,請參見修改RAM角色的信任策略。