服务端API接口

集成须知

接口说明

• 接口名：DescribeFaceGuardRisk

• 全局接入地址：cloudauth.aliyuncs.com（IPv4）或cloudauth-dualstack.aliyuncs.com（IPv6）

• 请求方法：POST和GET

• 传输协议：HTTPS

• 重要

  人脸保镖按照查询成功计量，建议您同一个 Device Token 查询成功后不要再重复查询，避免重复计量。

请求参数

返回参数

SDK调用示例

调用示例默认使用Java语言演示，其他语言示例参见其他语言支持。

环境变量和依赖

• 重要

  集成前请确认您已获取AccessKey，并已配置环境变量。具体操作，请参见：

  • 创建AccessKey

  • 在Linux、macOS和Windows系统上配置环境变量

• 在Java工程的pom.xml中引入依赖。

  重要

  SDK依赖请使用最新版本，并在测试稳定后固定版本号，最新版本和离线包，请参见集成须知>SDK安装和下载。

  <dependency>
     <groupId>com.aliyun</groupId>
     <artifactId>cloudauth20190307</artifactId>
     <version>LATEST</version>
  </dependency>

调用接口

package com.aliyun.Sample.Cloudauth20190307;

import com.aliyun.cloudauth20190307.models.DescribeFaceGuardRiskResponse;
import com.aliyun.tea.TeaException;
import com.google.gson.Gson;

import java.util.UUID;


public class DescribeFaceGuardRiskDemo {

    public static com.aliyun.cloudauth20190307.Client createClient() throws Exception {
        // 工程代码泄露可能会导致 AccessKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考。
        // 建议使用更安全的 STS 方式，更多鉴权访问方式请参见：https://help.aliyun.com/zh/sdk/developer-reference/v2-manage-access-credentials
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
                // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
                .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
                .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        // Endpoint 请参考 https://api.aliyun.com/product/Cloudauth
        config.endpoint = "cloudauth.aliyuncs.com";
        return new com.aliyun.cloudauth20190307.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        //client只需要创建一遍
        com.aliyun.cloudauth20190307.Client client = DescribeFaceGuardRiskDemo.createClient();

        //发起请求
        com.aliyun.cloudauth20190307.models.DescribeFaceGuardRiskRequest describeFaceGuardRiskRequest = new com.aliyun.cloudauth20190307.models.DescribeFaceGuardRiskRequest()
                .setProductCode("FACE_GUARD")
                .setDeviceToken("<客户端获取的DeviceToken>")
                .setOuterOrderNo("7648ae2ce2ad423ea8a8d6de1676****")
                .setBizId(UUID.randomUUID().toString());
        com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions()
                .setReadTimeout(3000)
                .setConnectTimeout(3000);
        try {
            // 调用DescribeFaceGuardRisk接口，获取识别结果。
            DescribeFaceGuardRiskResponse response = client.describeFaceGuardRiskWithOptions(describeFaceGuardRiskRequest, runtime);
            System.out.println(new Gson().toJson(response));
        } catch (TeaException error) {
            // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            // 错误 message
            System.out.println(error.getMessage());
            // 诊断地址
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        } catch (Exception _error) {
            TeaException error = new TeaException(_error.getMessage(), _error);
            // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            // 错误 message
            System.out.println(error.getMessage());
            // 诊断地址
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        }
    }
}

其他语言支持

您可以在OpenAPI平台中查看其他语言的SDK调用示例。

每种语言对应的SDK安装信息在示例代码的右上角可以查看。