调用DescribeInstances查询DDoS高防实例的版本和状态信息,例如业务转发状态、到期状态、欠费状态等。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeInstances |
要执行的操作。取值:DescribeInstances |
PageNumber | String | 是 | 1 |
分页查询请求时返回的页码。例如,查询第一页的返回结果,则填写1。 |
PageSize | String | 是 | 10 |
页面显示的记录数量。最大值:50 |
RegionId | String | 否 | cn-hangzhou |
DDoS高防服务地域ID。取值:
|
ResourceGroupId | String | 否 | default |
DDoS高防实例在资源管理产品中所属的资源组ID。默认为空,即属于默认资源组。 |
InstanceIds.N | RepeatList | 否 | ddoscoo-cn-mp91j1ao**** |
DDoS高防实例的ID。 说明 您可以调用DescribeInstanceIds查询所有DDoS高防实例的ID信息。
|
Ip | String | 否 | 203.***.***.117 |
使用IP地址查询,指定要查询的DDoS高防实例的IP地址。支持精确匹配查询。 |
Remark | String | 否 | test |
使用实例备注查询,指定要查询的DDoS高防实例的备注。支持模糊查询。 |
Edition | Integer | 否 | 9 |
使用防护套餐查询,指定要查询的DDoS高防实例的防护套餐版本。取值:
|
Enabled | Integer | 否 | 1 |
使用业务转发状态查询,指定要查询的DDoS高防实例的业务转发状态。取值:
|
ExpireStartTime | Long | 否 | 1584460800000 |
使用实例到期时间查询,指定要查询的DDoS高防实例的到期开始时间。时间戳格式,单位:毫秒。 |
ExpireEndTime | Long | 否 | 1584560800000 |
使用实例到期时间查询,指定要查询的DDoS高防实例的到期结束时间。时间戳格式,单位:毫秒。 |
Status.N | RepeatList | 否 | 1 |
使用实例的到期状态查询,指定要查询的DDoS高防实例的到期状态。取值:
|
Tag.N.Key | String | 否 | testkey |
使用实例标签查询,指定要查询的DDoS高防实例的标签键。 说明 标签键(Tag.N.Key)与标签值(Tag.N.Value)必须键值匹配。
|
Tag.N.Value | String | 否 | a |
使用实例标签查询,指定要查询的DDoS高防实例的标签值。 说明 标签键(Tag.N.Key)与标签值(Tag.N.Value)必须键值匹配。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Instances | Array |
DDoS高防实例的版本和状态信息。 |
|
CreateTime | Long | 1581946582000 |
实例创建时间。时间戳格式,单位:毫秒。 |
DebtStatus | Integer | 0 |
实例的欠费状态。取值固定为0,表示不欠费,因为DDoS高防服务目前只支持包年包月的预付费计费方式。 |
Edition | Integer | 9 |
防护套餐版本。取值:
|
Enabled | Integer | 1 |
实例的业务转发状态。取值:
|
ExpireTime | Long | 1584460800000 |
实例到期时间。时间戳格式,单位:毫秒。 |
InstanceId | String | ddoscoo-cn-mp91j1ao**** |
实例ID。 |
Remark | String | test |
实例备注。 |
Status | Integer | 1 |
实例的到期状态。取值:
|
RequestId | String | A09C1F98-4CC1-4A31-B8F3-9E4B7437189F |
本次请求的ID。 |
TotalCount | Long | 1 |
DDoS高防实例的总数。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeInstances
&PageNumber=1
&PageSize=10
&<公共请求参数>
正常返回示例
XML
格式
<DescribeInstancesResponse>
<Instances>
<Status>1</Status>
<InstanceId>ddoscoo-cn-mp91j1ao****</InstanceId>
<CreateTime>1581946582000</CreateTime>
<Enabled>1</Enabled>
<ExpireTime>1584460800000</ExpireTime>
<Edition>9</Edition>
<Remark>test</Remark>
<DebtStatus>0</DebtStatus>
</Instances>
<TotalCount>1</TotalCount>
<RequestId>A09C1F98-4CC1-4A31-B8F3-9E4B7437189F</RequestId>
</DescribeInstancesResponse>
JSON
格式
{
"Instances": [
{
"Status": 1,
"InstanceId": "ddoscoo-cn-mp91j1ao****",
"CreateTime": 1581946582000,
"Enabled": 1,
"ExpireTime": 1584460800000,
"Edition": 9,
"Remark": "test",
"DebtStatus": 0
}
],
"TotalCount": 1,
"RequestId": "A09C1F98-4CC1-4A31-B8F3-9E4B7437189F"
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交