查询云防火墙访问控制策略地址簿的详细信息。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| 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 |
返回参数
示例
正常返回示例
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\" ]"
]
}
]
}错误码
| 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. | 内部错误：数据库查询错误 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-08-29 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-11-21 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2022-06-02 | OpenAPI 错误码发生变更 | 查看变更详情 |