接口请求域名: faceid.intl.tencentcloudapi.com 。
持续名单筛查状态变更
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:UpdateAMLOngoingScreeningStatus。 |
| Version | 是 | String | 公共参数,本接口取值:2018-03-01。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-hongkong, ap-singapore 。 |
| UniqueCustomerID | 是 | String | 客户系统中终端用户的唯一标识,最长 256 字符。 |
| EnableOngoingScreening | 是 | Boolean | 是否开启持续监控筛查,默认 false 默认值:false |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| UniqueCustomerID | String | 客户系统中终端用户的唯一标识 |
| EnableOngoingScreening | Boolean | 是否开启持续监控筛查 |
| Description | String | 返回结果描述 |
| Result | String | 返回结果 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: faceid.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateAMLOngoingScreeningStatus
<公共请求参数>
{
"UniqueCustomerID": "USER_20260904_001",
"EnableOngoingScreening": false
}
{
"Response": {
"Description": "成功",
"EnableOngoingScreening": false,
"Result": "Success",
"UniqueCustomerID": "USER_20260904_001",
"RequestId": "84f22af4-9167-4e49-9d5f-db2987116bed"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.AMLDBError | AML database operation error. |
| FailedOperation.AMLInternalError | AML service internal error. |
| FailedOperation.AMLOngoingScreeningAlreadyEnabled | Ongoing screening is already enabled for this customer. No action needed. |
| FailedOperation.AMLOngoingScreeningSetupIncomplete | Ongoing screening setup is incomplete. Please retry the screening request or contact support if the issue persists. |
| FailedOperation.AMLProviderError | AML provider service error. |
| FailedOperation.AMLProviderTimeout | AML provider service timeout. |
| FailedOperation.AMLTokenError | Failed to obtain AML provider access token. |
| FailedOperation.CustomerNotFound | Customer not found. Please check the UniqueCustomerID or call RunAMLNameScreening first. |
| InvalidParameterValue.AMLFieldValidation | Field validation failed |
| InvalidParameterValue.MissingUniqueCustomerID | UniqueCustomerID is required. |
| ResourceNotFound.AMLCustomer | Customer mapping not found for the given identifier. |
文档反馈