调用DescribeInstanceIds查询DDoS高防实例的ID、版本、备注、IP类型信息。
使用说明
本接口用于查询所有DDoS高防实例的ID、版本、备注、IP类型信息。
QPS限制
本接口的单用户QPS限制为10次/秒。超过限制,API调用将会被限流,这可能影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeInstanceIds |
要执行的操作。取值:DescribeInstanceIds。 |
RegionId | String | 否 | cn-hangzhou |
DDoS高防实例所属地域ID。取值:
|
ResourceGroupId | String | 否 | rg-acfm2pz25js**** |
DDoS高防实例在资源管理服务中所属的资源组ID。 不设置该参数表示默认资源组。 |
Edition | Integer | 否 | 9 |
要查询的DDoS高防实例的类型。取值:
|
InstanceIds.N | String | 否 | ddoscoo-cn-zvp2eibz**** |
要查询的DDoS高防实例的ID。 不设置该参数表示查询所有DDoS高防实例。 |
调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数。
调用API的请求格式,请参见本文示例中的请求示例。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 310A41FD-0990-5610-92E0-A6A55D7C6444 |
本次请求的ID。 |
InstanceIds | Array of Instance |
DDoS高防实例的ID、版本、备注、IP类型信息。 |
|
IpMode | String | fnat |
实例的IP转发模式。取值:
|
Edition | Integer | 9 |
实例的类型。取值:
|
InstanceId | String | ddoscoo-cn-zvp2eibz**** |
实例ID。 |
IpVersion | String | Ipv4 |
实例的IP协议版本。取值:
|
Remark | String | test |
实例的备注。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeInstanceIds
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeInstanceIdsResponse>
<RequestId>310A41FD-0990-5610-92E0-A6A55D7C6444</RequestId>
<InstanceIds>
<IpMode>fnat</IpMode>
<Edition>9</Edition>
<InstanceId>ddoscoo-cn-zvp2eibz****</InstanceId>
<IpVersion>Ipv4</IpVersion>
<Remark>test</Remark>
</InstanceIds>
</DescribeInstanceIdsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "310A41FD-0990-5610-92E0-A6A55D7C6444",
"InstanceIds" : [ {
"IpMode" : "fnat",
"Edition" : 9,
"InstanceId" : "ddoscoo-cn-zvp2eibz****",
"IpVersion" : "Ipv4",
"Remark" : "test"
} ]
}
错误码
访问错误中心查看更多错误码。