文档

DescribeInstanceSpecs - 查询防护包的规格信息

更新时间:

查询指定的DDoS原生防护企业版实例的规格信息。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
InstanceIdListstring

要查询的 DDoS 原生防护企业版实例的 ID。使用 JSON 数组转化的字符串格式表示。JSON 数组中的每个元素表示一个实例 ID(字符串格式),多个 ID 间使用英文逗号(,)分隔。

说明 您可以调用 DescribeInstanceList 查询指定地域下所有 DDoS 原生防护企业版实例的 ID。
["ddosbgp-cn-n6w1r7nz****"]
RegionIdstring

DDoS 原生防护企业版实例的地域 ID。默认为cn-hangzhou,表示华东 1(杭州)。

说明 如果您的实例不在华东 1(杭州)地域,则此处必须填写实例所在地域的 ID。您可以调用 DescribeRegions 查询所有的 RegionId
cn-hangzhou
ResourceGroupIdstring

DDoS 原生防护企业版实例在资源管理服务中所属的资源组 ID。默认为空,即属于默认资源组。

关于资源组的更多信息,请参见创建资源组

rg-acfm2pz25js****

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

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

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

5840AB9F-1419-4620-807D-5EA476090247
InstanceSpecsobject []

DDoS 原生防护企业版实例的规格信息,包含全力防护的开启状态、可用和已用的全力防护次数等。

IsFullDefenseModeinteger

该实例是否开启了全力防护模式。取值:

  • 0:未开启全力防护模式。
  • 1:开启了全力防护模式。
1
Regionstring

DDoS 原生防护企业版实例的地域 ID。

说明 您可以调用 DescribeRegions 查询地域 ID 的具体含义。
cn-hangzhou
AvailableDefenseTimesinteger

当前可用的全力防护次数。

2
TotalDefenseTimesinteger

总共可用的全力防护次数。

2
DefenseTimesPercentinteger

全力防护次数使用的百分比。单位:百分比。

30
AvailableDeleteBlackholeCountstring

当前可用的解除黑洞次数。

100
InstanceIdstring

DDoS 原生防护企业版实例的 ID。

ddosbgp-cn-n6w1r7nz****
PackConfigobject

DDoS 原生防护企业版实例的配置信息,包含防护 IP 数量、防护带宽信息等。

PackBasicThreinteger

原生防护企业版实例的基础防护带宽。单位:Gbps。

20
BindIpCountinteger

已添加防护的 IP 数量。

0
PackAdvThreinteger

原生防护企业版实例的弹性防护带宽。单位:Gbps。

300
NormalBandwidthinteger

正常业务带宽。单位:Mbps。

200
IpBasicThreinteger

被防护 IP 的基础防护阈值。单位:Gbps。

20
IpAdvanceThreinteger

被防护 IP 的弹性防护阈值。单位:Gbps。

300
IpSpecinteger

可添加的防护 IP 的数量。

100
Bandwidthlong

带宽。单位:Gbit/s。

2

示例

正常返回示例

JSON格式

{
  "RequestId": "5840AB9F-1419-4620-807D-5EA476090247",
  "InstanceSpecs": [
    {
      "IsFullDefenseMode": 1,
      "Region": "cn-hangzhou",
      "AvailableDefenseTimes": 2,
      "TotalDefenseTimes": 2,
      "DefenseTimesPercent": 30,
      "AvailableDeleteBlackholeCount": "100",
      "InstanceId": "ddosbgp-cn-n6w1r7nz****",
      "PackConfig": {
        "PackBasicThre": 20,
        "BindIpCount": 0,
        "PackAdvThre": 300,
        "NormalBandwidth": 200,
        "IpBasicThre": 20,
        "IpAdvanceThre": 300,
        "IpSpec": 100,
        "Bandwidth": 2
      }
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-11-23OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)