DescribeDdosIpAddresses
1. 接口描述
调用本接口用于查询一台或多台指定Ddos IP的信息。用户可以根据Ddos IP ID、IP或者计费模式等信息来搜索Ddos IP信息。
2. 请求参数
以下请求参数列表仅列出了接口中需要的请求参数
参数名称
必选
类型
描述
ddosIpChargeType
否
String
付费类型。
PREPAID:预付费,即包年包月。
POSTPAID:后付费。
ddosIpIds
否
Array of String
Ddos IP ID。
取值可以由多个Ddos IP ID共同组成。
最多支持100个ID查询。
instanceId
否
String
机器实例ID。
instanceName
否
String
机器实例名称。
ipAddress
否
String
IP地址。
zoneId
否
String
Ddos IP所属的可用区ID。
resourceGroupId
否
String
资源组的ID。
如果不传,则返回该用户可见的所有资源组内的Ddos IP。
pageNum
否
Integer
返回的分页数。
默认为1。
pageSize
否
Integer
返回的分页大小。
默认为20,最大为1000。
3. 响应结果
参数名称
类型
描述
request
String
唯一请求 ID。
每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
totalCount
Integer
符合条件的Ddos IP总数量。
4. 代码示例
1. 列表根据ddosIpChargeType搜索
过滤出ddosIpChargeType
是PREPAID
的数据。
POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeDdosIpAddresses
<Common Request Params>
Request:
{
"ddosIpChargeType": "PREPAID"
}
Response:
{
"requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
"response": {
"requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
"dataSet": [
{
"ddosIpId": "ddosIpId1",
"zoneId": "SEL-A",
"ipAddress": "x.x.x.x",
"instanceId": "instanceId1",
"instanceName": "instanceName",
"ddosIpChargeType": "PREPAID",
"period": 1,
"createTime": "2022-09-25T16:53:38.000Z",
"expiredTime": "2022-10-25T16:53:38.000Z",
"ddosIpStatus": "AVAILABLE",
"resourceGroupId": "xx",
"resourceGroupName": "xx"
}
],
totalCount: 1
}
}
5. 开发者工具
Zenlayer Cloud API 2.0 提供了配套的开发工具集(SDK),未来会陆续支持更多开发语言,方便快速接入和使用Zenlayer的产品和服务。
6. 错误码
下面包含业务逻辑中遇到的错误码,其他错误码见公共错误码
HTTP状态码
错误码
说明
最后更新于