使用OpenAPI示例

查看OpenAPI文档

通过阅读API概览得知，查询DDoS原生防护实例详情的OpenAPI为DescribeInstanceList。请您根据文档，了解调用该接口需要准备的数据和权限。

创建RAM用户并授权

身份

您可以使用阿里云账号（主账号）、RAM用户、RAM角色调用该接口，有关各种身份的差异，请参见身份、凭证、授权。本案例中，我们使用RAM用户进行接口调用。

登录RAM访问控制，创建一个仅允许API调用的RAM用户，并记录AccessKey信息。具体操作，请参见创建RAM用户。

授权

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

2. 在选择权限区块中输入关键字Yundunddos进行搜索，选择AliyunYundunDDosFullAccess策略。

   说明

   • DDoS原生防护的系统权限策略如下：

     • AliyunYundunAntiDDoSBagFullAccess：管理DDoS原生防护（Anti-DDoS Origin）的权限。

     • AliyunYundunAntiDDoSBagReadOnlyAccess：只读访问DDoS原生防护（Anti-DDoS Origin）的权限。

   • 关于如何创建自定义权限，请参见授权信息。

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

凭证

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

调用OpenAPI

本文以Python语言为例，为您介绍OpenAPI的调用方法。

准备Python环境

1. 下载并安装Python。

   Python 3的下载地址，请参见Python 3。

2. 查看Python版本。

   • Linux和macOS系统

     打开终端，输入python --version。

   • Windows系统

     • 在Python的安装路径下，双击python.exe。

     • 打开命令提示符页面。

       通过键盘快捷键Win+R打开运行对话框，输入命令python，单击确定。

配置环境变量

为避免将AccessKey硬编码到业务代码中带来的安全风险，本示例采用配置环境变量的方法管理AccessKey。

• Linux和macOS系统

  将以下命令中的<access_key_id>和<access_key_secret>替换为您自己的AccessKey ID和AccessKey Secret，输入到终端执行。

export ALIBABA_CLOUD_ACCESS_KEY_ID=<access_key_id>
export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<access_key_secret>

• Windows系统

  新建环境变量文件，添加环境变量ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET，并写入已准备好的AccessKey ID和AccessKey Secret。然后重启Windows系统。

安装依赖

pip install alibabacloud_credentials
pip install alibabacloud_ddosbgp20180720==2.0.2
pip install alibabacloud_tea_console

下载示例代码

1. 在OpenAPI门户，访问DescribeInstanceList接口的调试地址。

2. 请求参数InstanceIdList输入["ddosbgp-cn-nwy36lfg****","ddosbgp-cn-zxu3ajul****"]，RegionId输入cn-hangzhou，PageNo输入1，PageSize输入10，直接单击发起调用。

3. 先单击SDK示例页签，再单击Python页签。

   获取Python语言的SDK示例。

4. 单击下载完整工程，下载示例代码包。

5. 在本地解压示例代码包，并进入alibabacloud_sample目录。

运行代码

执行以下命令：

python sample.py

得到如下输出结果：

{
  "RequestId": "116D9BB2-57C0-5757-AFFB-8DE6FB13F8FC",
  "Total": 2,
  "InstanceList": [
    {
      "Status": "1",
      "GmtCreate": 1681983249000,
      "AutoRenewal": true,
      "IpType": "IPv6",
      "InstanceId": "ddosbgp-cn-nwy36lfg****",
      "BlackholdingCount": 0,
      "ExpireTime": 1713628800000,
      "InstanceType": "1",
      "CoverageType": 0,
      "Remark": "ddos_ipv6_auto"
    },
    {
      "Status": "1",
      "GmtCreate": 1688628005000,
      "AutoRenewal": true,
      "IpType": "IPv4",
      "InstanceId": "ddosbgp-cn-zxu3ajul****",
      "BlackholdingCount": 0,
      "ExpireTime": 1720281600000,
      "InstanceType": "1",
      "CoverageType": 0,
      "Remark": "ddos_autotest"
    }
  ]
}