You need to enable JavaScript to run this app.
导航
DescribeAddressBook - 查询访问控制地址簿
最近更新时间:2024.11.25 17:03:53首次发布时间:2024.03.28 17:09:33

根据地址簿类型、名称、描述或内容查询访问控制地址簿。

请求说明

  • 请求方式:POST
  • 请求地址:?Action=DescribeAddressBook&Version=2021-09-06

调试

请求参数

Query

参数类型是否必选示例值描述
ActionStringDescribeAddressBook接口名称。当前 API 的名称为 DescribeAddressBook
VersionString2021-09-06接口版本。当前 API 的版本为 2021-09-06

Body

参数类型是否必选示例值描述

GroupType

String

ip

查询条件,精确查询。地址簿类型:

  • ip - IP地址簿
  • port - 端口地址簿
  • domain - 域名地址簿
PageNumberInteger1分页页码,默认值为1
PageSizeInteger10分页大小,默认值为10
QueryString180.*.*.*查询条件,模糊查询。支持地址簿名称、描述信息、地址列表

返回参数

参数类型示例值描述
CountInteger1返回数据的实际数量 当查询数据为空时,且使用python SDK调用时此项为None
DataArray of AddressBookStructure--地址簿详情。
PageNumberInteger1返回数据的分页页码
PageSizeInteger10返回数据的分页大小
TotalCountInteger1返回数据总数量 当查询数据为空时,且使用python SDK调用时此项为None

AddressBookStructure

参数类型示例值描述
RefCntInteger20引用次数
GroupNameStringAddressBookName地址簿名称

GroupType

String

ip

地址簿类型:

  • ip - IP地址簿
  • port - 端口地址簿
  • domain - 域名地址簿
GroupUuidStringf04ac7ce-****-****-****-************地址簿唯一标识ID
AddressListArray of String180.*.*.1/32地址列表
DescriptionStringDescription描述信息

请求示例

POST ?Action=DescribeAddressBook&Version=2021-09-06
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240711T081413Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240711/cn-beijing/fw_center/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
    "GroupType": "ip",
    "PageNumber": 1,
    "PageSize": 10,
    "Query": "180.*.*.*"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "DescribeAddressBook",
        "Region": "cn-beijing",
        "Service": "fw_center",
        "Version": "2021-09-06",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Count": 1,
        "Data": [
            {
                "RefCnt": 20,
                "GroupName": "AddressBookName",
                "GroupType": "ip",
                "GroupUuid": "f04ac7ce-****-****-****-************",
                "AddressList": [
                    "180.*.*.1/32"
                ],
                "Description": "Description"
            }
        ],
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1
    }
}