根据地址簿类型、名称、描述或内容查询访问控制地址簿。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeAddressBook | 接口名称。当前 API 的名称为 DescribeAddressBook 。 |
Version | String | 是 | 2021-09-06 | 接口版本。当前 API 的版本为 2021-09-06 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
GroupType | String | 否 |
| 查询条件,精确查询。地址簿类型:
|
PageNumber | Integer | 否 | 1 | 分页页码,默认值为1 |
PageSize | Integer | 否 | 10 | 分页大小,默认值为10 |
Query | String | 否 | 180.*.*.* | 查询条件,模糊查询。支持地址簿名称、描述信息、地址列表 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Count | Integer | 1 | 返回数据的实际数量 当查询数据为空时,且使用python SDK调用时此项为None |
Data | Array of AddressBookStructure | -- | 地址簿详情。 |
PageNumber | Integer | 1 | 返回数据的分页页码 |
PageSize | Integer | 10 | 返回数据的分页大小 |
TotalCount | Integer | 1 | 返回数据总数量 当查询数据为空时,且使用python SDK调用时此项为None |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
RefCnt | Integer | 20 | 引用次数 |
GroupName | String | AddressBookName | 地址簿名称 |
GroupType | String |
| 地址簿类型:
|
GroupUuid | String | f04ac7ce-****-****-****-************ | 地址簿唯一标识ID |
AddressList | Array of String | 180.*.*.1/32 | 地址列表 |
Description | String | Description | 描述信息 |
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 } }