文档

OpenAPI集成示例(SDK)

更新时间:

本文为您介绍如何通过SDK调用OpenAPI查询敏感数据识别规则的列表。

查看OpenAPI文档

阅读API概览,选择可以查询指定地域实例列表的OpenAPI:DescribeRules - 查询识别规则的列表。根据接口文档,了解调用该接口需要的参数及权限。

创建RAM用户并授权

身份

您可以使用阿里云账号(主账号)、RAM用户、RAM角色调用该接口,有关各种身份的差异请参见身份、凭据、授权。本案例中,我们使用RAM用户进行接口调用。登录RAM访问控制,创建一个仅允许API调用的RAM用户,记录AccessKey信息,更多详情请参见创建RAM用户

授权

  1. 访问RAM用户列表,单击目标RAM用户操作列的添加权限

  2. 选择权限区块中输入关键字sddp进行搜索,根据实际需要选择策略。

    说明

    AliyunYundunSDDPFullAccess管理数据安全中心的权限。

    AliyunYundunSDDPReadOnlyAccess:只读访问数据安全中心的权限。

    AliyunYundunSDDPDataManager:数据安全中心的数据域管理权限。

    如何新建自定义权限,请参见授权信息

  3. 单击确定,完成授权操作。

凭证

在创建RAM用户时会默认生成一个AccessKey,可直接使用。您也可进入到对应的RAM用户详情页,在认证管理页签,单击创建 AccessKey。具体操作,请参见创建AccessKey

调用OpenAPI

本文使用Java语言SDK。关于阿里云SDK的更多信息,请参见快速开始

配置环境变量

通过在环境变量中设置AccessKey信息避免在代码中直接硬编码AccessKey给业务带来安全风险。

以在Linux和macOS系统中配置环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET为例。

  1. 创建.bash_profile文件

    说明

    如果是第一次设置环境变量,可以使用touch ~/.bash_profile创建一个配置文件,如果已经存在配置文件,则使用vim ~/.bash_profile命令直接编辑文件。

    touch ~/.bash_profile
    vim ~/.bash_profile
  2. 配置.bash_profile文件

    # 将以下命令中的<ACCESS_KEY_ID>和<ACCESS_KEY_SECRET>替换为您自己的AccessKey ID和AccessKey Secret。
    # 变量名称可以根据实际情况进行替换,例如OSS_ACCESS_KEY_ID、OSS_ACCESS_KEY_SECRET。
    export ALIBABA_CLOUD_ACCESS_KEY_ID=<ACCESS_KEY_ID>
    export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<ACCESS_KEY_SECRET>

    编辑完成后保存退出。

  3. 使用.bash_profile文件

    # 使配置文件生效
    source ~/.bash_profile
    # 显示配置是否生效
    echo $ALIBABA_CLOUD_ACCESS_KEY_ID

    若返回正确的AccessKey,则说明配置成功。

关于在Windows系统环境变量中设置AccessKey信息的详细内容,请参见在Windows系统环境变量中设置阿里云AccessKey

下载示例代码

  1. 访问DescribeRules

  2. 在左侧的参数配置页签,填写参数信息。

  3. 在右侧的SDK示例页签,SDK版本选择v2.0,语言选择Java语言,单击下载完整工程按钮,下载示例代码包。

  4. 本地解压并进入sample目录。

打开并运行项目

使用IntelliJ IDEA加载项目,待相关依赖加载完毕后,打开 src/main/java/com/aliyun/sample/Sample.java。根据代码中的注释提示自行添加打印返回值的代码。

单击IDE右上角的运行按钮,可查看输出日志。本案例中的返回内容如下:

{
  "TotalCount": 568,
  "RequestId": "B62E33DC-368B-52E8-A401-1DFFEB0D4DD8",
  "PageSize": 2,
  "CurrentPage": 1,
  "Items": [
    {
      "Status": 1,
      "CustomType": 1,
      "LoginName": "sddp_test",
      "Category": 5,
      "GmtModified": 1693215690000,
      "Name": "delete_test",
      "HitTotalCount": 0,
      "GroupId": "",
      "GmtCreate": 1693215690000,
      "MatchType": 1,
      "Content": "[{\"rule\":[{\"target\":\"content\"}],\"ruleRelation\":\"AND\"}]",
      "DisplayName": "User01",
      "SupportForm": 1,
      "CategoryName": "关键字",
      "Id": 9950553,
      "ContentCategory": 108
    },
    {
      "Status": 1,
      "CustomType": 1,
      "LoginName": "sddp_test",
      "Category": 5,
      "GmtModified": 1692950931000,
      "Name": "OCR-test",
      "HitTotalCount": 0,
      "GroupId": "",
      "GmtCreate": 1692950931000,
      "MatchType": 1,
      "Content": "[{\"rule\":[{\"operator\":\"contains\",\"target\":\"fileName\",\"value\":\"Orc\"}],\"ruleRelation\":\"AND\"}]",
      "DisplayName": "User01",
      "SupportForm": 2,
      "CategoryName": "User01",
      "Id": 9950551,
      "ContentCategory": 108
    }
  ]
}