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

使用说明

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

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeInstances

要执行的操作。取值:DescribeInstances

RegionId String cn-hangzhou

DDoS高防实例所属地域ID。取值:

  • cn-hangzhou(默认):表示中国内地,即DDoS高防(新BGP)实例。
  • ap-southeast-1:表示非中国内地,即DDoS高防(国际)实例。
ResourceGroupId String rg-acfm2pz25js****

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

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

PageNumber String 1

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

PageSize String 10

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

Ip String 203.107.XX.XX

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

Remark String doc-test

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

Edition Integer 9

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

  • 0:表示DDoS高防(国际)保险版。
  • 1:表示DDoS高防(国际)无忧版。
  • 2: 表示DDoS高防(国际)加速线路。
  • 9:表示DDoS高防(新BGP)专业版。
Enabled Integer 1

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

  • 0:表示已停止转发业务流量。
  • 1:表示正常转发业务流量。
ExpireStartTime Long 1640361500000

要查询的DDoS高防实例的最早到期时间(即查询到期时间在ExpireStartTime之后的DDoS高防实例)。使用时间戳表示,单位:毫秒。

ExpireEndTime Long 1640361700000

要查询的DDoS高防实例的最晚到期时间(即查询到期时间在ExpireEndTime之前的DDoS高防实例)。使用时间戳表示,单位:毫秒。

InstanceIds.N String ddoscoo-cn-7pp2g9ed****

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

Status.N Integer 1

要查询的DDoS高防实例的状态。取值:

  • 1:表示正常。
  • 2:表示已过期。
Tag.N.Key String test-key

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

说明 标签键(Key)和标签值(Value)必须成对出现。
Tag.N.Value String test-value

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

说明 标签键(Key)和标签值(Value)必须成对出现。

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

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

返回数据

名称 类型 示例值 描述
TotalCount Long 1

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

RequestId String A0AF40CC-814A-5A86-AEAA-6F19E88B8A39

本次请求的ID。

Instances Array of Instance

DDoS高防实例的详情列表。

Status Integer 1

实例的状态。取值:

  • 1:表示正常。
  • 2:表示已过期。
IpMode String fnat

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

  • fnat:表示源站和客户端的IP版本一致,即IPv4地址客户端请求转发到IPv4地址源站、IPv6地址客户端请求转发到IPv6地址源站。
  • v6tov4:表示IPv6地址客户端请求转发到IPv4地址源站。
DebtStatus Integer 0

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

Edition Integer 9

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

  • 0:表示DDoS高防(国际)保险版。
  • 1:表示DDoS高防(国际)无忧版。
  • 2: 表示DDoS高防(国际)加速线路。
  • 9:表示DDoS高防(新BGP)专业版。
IpVersion String Ipv4

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

  • Ipv4:表示IPv4协议。
  • Ipv6:表示IPv6协议。
ExpireTime Long 1640361600000

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

Remark String doc-test

实例的备注。

CreateTime Long 1637751953000

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

Enabled Integer 1

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

  • 0:表示已停止转发业务流量。
  • 1:表示正常转发业务流量。
InstanceId String ddoscoo-cn-7pp2g9ed****

实例的ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeInstances
&PageNumber=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstancesResponse>
    <TotalCount>1</TotalCount>
    <RequestId>A0AF40CC-814A-5A86-AEAA-6F19E88B8A39</RequestId>
    <Instances>
        <Status>1</Status>
        <IpMode>fnat</IpMode>
        <DebtStatus>0</DebtStatus>
        <Edition>9</Edition>
        <IpVersion>Ipv4</IpVersion>
        <ExpireTime>1640361600000</ExpireTime>
        <Remark>doc-test</Remark>
        <CreateTime>1637751953000</CreateTime>
        <Enabled>1</Enabled>
        <InstanceId>ddoscoo-cn-7pp2g9ed****</InstanceId>
        <ConnInstanceId>1</ConnInstanceId>
    </Instances>
</DescribeInstancesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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****",
    "ConnInstanceId" : "1"
  } ]
}

错误码

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