查询云防火墙访问控制策略地址簿的详细信息。
接口说明
本接口一般用于查询访问控制策略地址簿的详细信息。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
yundun-cloudfirewall:DescribeAddressBook |
get |
*全部资源
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
Lang |
string |
否 |
请求消息的语言类型。取值:
|
zh |
CurrentPage |
string |
否 |
分页查询时,设置当前页面的页码。 默认值为 1,表示返回第 1 页数据。 |
1 |
PageSize |
string |
否 |
分页查询时,设置每页包含的地址簿的数量。 默认值为 10,表示每页包含 10 条结果。最大值为 50。 |
10 |
Query |
string |
否 |
搜索条件,输入待查询地址簿信息。 |
192.0.XX.XX |
GroupType |
string |
否 |
地址簿的类型。取值:
说明
不设置该参数表示查询 IP 地址簿和 ECS 标签地址簿。 |
ip |
ContainPort |
string |
否 |
查询包含指定端口的地址簿。仅当 GroupType 参数的值为 port 时,该参数才会作为本次查询的条件。 |
80 |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
PageNo |
string |
当前页面的页码。 |
1 |
PageSize |
string |
每页包含的地址簿的数量。 |
10 |
RequestId |
string |
结果的请求 ID。 |
B36F150A-1E27-43AA-B72C-D2AC712F09DA |
TotalCount |
string |
地址簿的总数量。 |
100 |
Acls |
array |
地址簿信息。 |
|
object |
|||
AddressListCount |
integer |
地址簿中包含地址的个数。 |
2 |
GroupUuid |
string |
地址簿的唯一标识 ID。 |
f04ac7ce-628b-4cb7-be61-310222b7**** |
AutoAddTagEcs |
integer |
是否自动添加新匹配标签的 ECS(新购且完成标签设置的 ECS 或修改标签的 ECS)公网 IP 到地址簿。取值:
|
1 |
Description |
string |
地址簿的描述信息。 |
DEMO地址簿 |
GroupName |
string |
地址簿的名称。 |
demo_address_book |
ReferenceCount |
integer |
地址簿被引用次数。 |
3 |
GroupType |
string |
地址簿的类型。取值:
|
ip |
TagRelation |
string |
多个 ECS 标签间的关系。取值:
|
and |
TagList |
array |
地址簿支持自动添加的待匹配 ECS 标签信息。 |
|
object |
|||
TagValue |
string |
待匹配的 ECS 标签值。 |
全部VALUE |
TagKey |
string |
待匹配的 ECS 标签 Key。 |
company |
AddressList |
array |
地址簿的地址列表。 |
|
string |
地址簿的地址列表信息。 |
[ "192.168.XX.XX/32", "192.168.XX.XX/32" ] |
|
Addresses |
array |
地址簿的含单地址描述的地址列表。 |
|
object |
地址簿的含单地址描述的地址。 |
||
Address |
string |
地址簿的地址信息。 |
192.168.0.1/32 |
Note |
string |
单地址描述。 |
单地址描述 |
示例
正常返回示例
JSON
格式
{
"PageNo": "1",
"PageSize": "10",
"RequestId": "B36F150A-1E27-43AA-B72C-D2AC712F09DA",
"TotalCount": "100",
"Acls": [
{
"AddressListCount": 2,
"GroupUuid": "f04ac7ce-628b-4cb7-be61-310222b7****",
"AutoAddTagEcs": 1,
"Description": "DEMO地址簿",
"GroupName": "demo_address_book",
"ReferenceCount": 3,
"GroupType": "ip",
"TagRelation": "and",
"TagList": [
{
"TagValue": "全部VALUE",
"TagKey": "company"
}
],
"AddressList": [
"[ \"192.168.XX.XX/32\", \"192.168.XX.XX/32\" ]"
],
"Addresses": [
{
"Address": "192.168.0.1/32",
"Note": "单地址描述"
}
]
}
]
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | ErrorParametersGroupType | The group type is invalid. | 无效的group类型 |
400 | ErrorParametersUid | The aliUid parameter is invalid. | aliUid 不合法 |
400 | ErrorParametersPageSizeOrNo | Either pageSize or pageNo is invalid. | 无效的pageSize或者pageNo |
400 | ErrorDBSelect | An error occurred while querying database. | 内部错误:数据库查询错误 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。