调用DescribeInstances分页查询新BGP高防实例信息列表。

调试

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

请求参数

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

要执行的操作。取值:DescribeInstances

PageNo String 1

分页页号,即从几页开始显示。最小值是1

PageSize String 10

分页大小,即每页显示多少条结果。最大值是50

SourceIp String 1.1.1.1

请求源IP。无需填写,系统自动获取。

RegionId String xx

地域ID。

ResourceGroupId String xx

资源组ID。

InstanceIds String ["ddoscoo-cn-XXXXX"]

通过实例Id查询实例信息,传入要查询的实例Id数组(JSON字符串)。支持精确匹配。例如,["ddoscoo-cn-XXXX1", "ddoscoo-cn-XXXX2"]。

说明 若传入该参数,则无需传入IpRemark
Ip String 1.1.1.1

通过实例IP查询实例信息,传入要查询的实例IP地址。支持精确匹配查询。

说明 若传入该参数,则无需传入InstanceIdsRemark
Remark String testRemark

通过实例备注查询实例信息,传入要查询的实例的备注信息。支持模糊查询。

说明 若传入该参数,则无需传入InstanceIdsIp
Edition Integer 9

防护套餐版本,取值:9(专业版)。

Enabled Integer 1

实例工作状态,取值:

  • 1:正常转发业务
  • 0:已停止业务转发
Status.N RepeatList 1

实例售卖状态,取值:

  • 1:正常
  • 2:过期
  • 3:释放
Tag.N.Key String key

实例标签的标签键。N的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持128个字符,不能以aliyun和acs:开头,且不能包含 http:// 或者 https:// 。

说明 标签键(Tag.N.Key)与标签值(Tag.N.Value)必须键值匹配。
Tag.N.Value String value

实例标签的标签值。N的取值范围:1~20。一旦传入该值,可以为空字符串。最多支持128个字符,不能以aliyun和acs:开头,且不能包含 http:// 或者 https:// 。

说明 标签键(Tag.N.Key)与标签值(Tag.N.Value)必须键值匹配。

返回数据

名称 类型 示例值 描述
RequestId String CF33B4C3-196E-4015-AADD-5CAD00057B80

本次请求的ID。

Total Long 10

实例总数。

Instances Array

实例信息列表。

InstanceId String ddoscoo-cn-XXXXX

实例ID。

Remark String testRemark

实例备注信息。最大500字节。

Status Integer 1

实例售卖状态,取值:

  • 1:正常
  • 2:过期
  • 3:释放
DebtStatus Integer 0

固定取值:0,表示预付费实例。

ExpireTime Long 2308402384

实例到期时间。格式为时间戳,单位:毫秒。

GmtCreate Long 2308402384

实例创建时间。格式为时间戳,单位:毫秒。

Edition Integer 9

防护套餐版本,固定取值:9(专业版)。

Enabled Integer 1

实例工作状态,取值:

  • 1:正常转发业务
  • 0:已停止业务转发

示例

请求示例

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

正常返回示例

XML 格式

<Total>1</Total>
<Instances>
    <Status>1</Status>
    <Edition>9</Edition>
    <ExpireTime>1578931200000</ExpireTime>
    <InstanceId>ddoscoo-cn-xxxxxxx</InstanceId>
    <DebtStatus>0</DebtStatus>
    <GmtCreate>1576236360000</GmtCreate>
</Instances>
<RequestId>0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc</RequestId>

JSON 格式

{
  "Total": 1,
  "Instances": [
		{
			"Status": 1,
			"Edition": 9,
			"ExpireTime": 1578931200000,
			"InstanceId": "ddoscoo-cn-xxxxxxx",
			"DebtStatus": 0,
			"GmtCreate": 1576236360000
		}
  ],
  "RequestId": "0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc"
}

错误码

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