全部产品
Search

搜索本产品

    DDoS 防护：DescribeInstances - 分页查询新BGP高防实例信息列表

    文档中心

    DDoS 防护：DescribeInstances - 分页查询新BGP高防实例信息列表

    更新时间：Feb 07, 2023

    查询DDoS高防实例的详情列表。

    接口说明

    本接口用于分页查询当前阿里云账号拥有的DDoS高防实例的详情，例如，实例的ID、版本、到期时间、业务转发状态等。

    QPS限制

    本接口的单用户QPS限制为10次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    yundun-ddoscoo:DescribeInstancesList
    • DdosCoo
      acs:yundun-ddoscoo:*:{#accountId}:*
      无
    		无

    请求参数

    名称类型必填描述示例值
    ResourceGroupIdstring否

    DDoS高防实例在资源管理服务中所属的资源组ID。

    不设置该参数表示默认资源组。

    		rg-acfm2pz25js****
    PageNumberstring是

    分页查询时，设置当前页面的页码。

    		1
    PageSizestring是

    分页查询时，设置每页包含实例的数量。

    		10
    Ipstring否

    要查询的DDoS高防实例的IP地址。

    		203.107.XX.XX
    Remarkstring否

    要查询的DDoS高防实例的备注。支持模糊查询。

    		doc-test
    Editioninteger否

    要查询的DDoS高防实例的防护套餐版本。取值：

    • 0：表示DDoS高防（国际）保险版。
    • 1：表示DDoS高防（国际）无忧版。
    • 2： 表示DDoS高防（国际）加速线路。
    • 9：表示DDoS高防（新BGP）专业版。
    		9
    Enabledinteger否

    要查询的DDoS高防实例的业务流量转发状态。取值：

    • 0：表示已停止转发业务流量。
    • 1：表示正常转发业务流量。
    		1
    ExpireStartTimelong否

    要查询的DDoS高防实例的最早到期时间（即查询到期时间在ExpireStartTime之后的DDoS高防实例）。使用时间戳表示，单位：毫秒。

    		1640361500000
    ExpireEndTimelong否

    要查询的DDoS高防实例的最晚到期时间（即查询到期时间在ExpireEndTime之前的DDoS高防实例）。使用时间戳表示，单位：毫秒。

    		1640361700000
    InstanceIdsarray否

    要查询的DDoS高防实例的ID列表。

    string否

    要查询的DDoS高防实例的ID。N的最大值：200，即最多可配置200个DDoS高防实例，实例ID之间用半角逗号（,）隔开。

    		ddoscoo-cn-7pp2g9ed****
    Statusarray否

    要查询的DDoS高防实例的状态列表。

    integer否

    要查询的DDoS高防实例的状态。N的最大值：2，即最多可配置2个DDoS高防实例状态，实例状态之间用半角逗号（,）隔开。取值：

    • 1：表示正常。
    • 2：表示已过期。
    		1
    Tagarray否

    要查询的DDoS高防实例绑定的标签。

    object否
    Keystring否

    要查询的DDoS高防实例绑定的标签键。N的最大值：200，即最多可配置200个标签键。配置规则如下：

    • 每个标签包含一个标签键（Key）和一个标签值（Value），中间用半角逗号（,）隔开。
    • 标签之间用半角逗号（,）隔开。
    说明标签键（Key）和标签值（Value）必须成对出现。
    		test-key
    Valuestring否

    要查询的DDoS高防实例绑定的标签值。N的最大值：200，即最多可配置200个标签值。配置规则如下：

    • 每个标签包含一个标签键（Key）和一个标签值（Value），中间用半角逗号（,）隔开。
    • 标签之间用半角逗号（,）隔开。
    说明标签键（Key）和标签值（Value）必须成对出现。
    		test-value

    调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见公共参数。

    调用API的请求格式，请参见本文示例中的请求示例。

    返回参数

    名称类型描述示例值
    object
    TotalCountlong

    查询到的DDoS高防实例的总数量。

    		1
    RequestIdstring

    本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。

    		A0AF40CC-814A-5A86-AEAA-6F19E88B8A39
    Instancesarray

    DDoS高防实例的详情列表。

    object
    Statusinteger

    实例的状态。取值：

    • 1：表示正常。
    • 2：表示已过期。
    		1
    IpModestring

    实例的IP转发模式。取值：

    • fnat：表示源站和客户端的IP版本一致，即IPv4地址客户端请求转发到IPv4地址源站、IPv6地址客户端请求转发到IPv6地址源站。
    • v6tov4：表示IPv6地址客户端请求转发到IPv4地址源站。
    		fnat
    DebtStatusinteger

    实例的欠费状态。取值固定为0，表示不欠费，因为DDoS高防服务目前只支持包年包月的预付费计费方式。

    		0
    Editioninteger

    实例的防护套餐版本。取值：

    • 0：表示DDoS高防（国际）保险版。
    • 1：表示DDoS高防（国际）无忧版。
    • 2： 表示DDoS高防（国际）加速线路。
    • 9：表示DDoS高防（新BGP）专业版。
    		9
    IpVersionstring

    实例的IP协议版本。取值：

    • Ipv4：表示IPv4协议。
    • Ipv6：表示IPv6协议。
    		Ipv4
    ExpireTimelong

    实例的到期时间。使用时间戳表示，单位：毫秒。

    		1640361600000
    Remarkstring

    实例的备注。

    		doc-test
    CreateTimelong

    实例的创建时间。使用时间戳表示，单位：毫秒。

    		1637751953000
    Enabledinteger

    实例的业务流量转发状态。取值：

    • 0：表示已停止转发业务流量。
    • 1：表示正常转发业务流量。
    		1
    InstanceIdstring

    实例的ID。

    		ddoscoo-cn-7pp2g9ed****
    IsFirstOpenBwlong

    实例是否开启过95计费模式。取值：

    • 0：表示未开启过。
    • 1：表示开启过。
    		0

    示例

    正常返回示例

    JSON格式

    {
  "TotalCount": 1,
  "RequestId": "A0AF40CC-814A-5A86-AEAA-6F19E88B8A39",
  "Instances": [
    {
      "Status": 1,
      "IpMode": "fnat",
      "DebtStatus": 0,
      "Edition": 9,
      "IpVersion": "Ipv4",
      "ExpireTime": 1640361600000,
      "Remark": "doc-test",
      "CreateTime": 1637751953000,
      "Enabled": 1,
      "InstanceId": "ddoscoo-cn-7pp2g9ed****",
      "IsFirstOpenBw": 0
    }
  ]
}

    错误码

    访问错误中心查看更多错误码。