接口功能介绍
查看前缀列表信息。
接口约束
无
URI
GET /openapi/v4/prefixlist/query
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b |
| prefixListID | 否 | String | prefixlistID | pl-r5i4zghgvq |
| queryContent | 否 | String | 模糊查询关键字 | “xxx |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success | |
| description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 | |
| errorCode | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS | SUCCESS | |
| returnObj | Object | 接口业务数据 | 见下表 | returnObj |
| totalCount | Integer | 列表条目数。 | 1 | |
| currentCount | Integer | 分页查询时每页的行数。 | 1 | |
| totalPage | Integer | 分页查询时总页数。 | 1 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| prefixlists | Array of Objects | prefixlists | prefixlist-d11hnu99el | prefixlists |
表 prefixlists
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| prefixlistID | String | prefixlist id | prefixlist-d11hnu99el | |
| name | String | prefixlist 名称 | prefixlist-4 | |
| limit | Integer | 前缀列表支持的最大条目容量 | 11 | |
| AddressType | String | 地址类型，4：ipv4，6：ipv6 | 4 | |
| description | String | 描述 | test | |
| createdAt | String | 创建时间 | ||
| updatedAt | String | 更新时间 | ||
| PrefixListRules | Array of Objects | 前缀列表规则 | PrefixListRules | PrefixListRules |
表 prefixListRules
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| prefixListRuleID | String | prefixlistRuleID | plrule-qosoz2hkxg |
| cidr | String | 前缀列表条目,cidr | 192.1.0.0/16 |
| description | String | 描述 | test |
请求示例
请求url
GET /openapi/v4/prefixlist/list?regionID=81f7728662dd11ec810800155d307d5b
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"prefixlists": [{
"prefixlistID": "prefixlist-r5i4zghgvq",
"name": "example",
"limit": 10,
"AddressType": 4,
"description": "",
"PrefixListRules": [
{
"prefixListRuleID": "plrule-4q1uoeh6pk",
"cidr": "0.0.0.0/0",
"description": ""
}
],
"createdAt": "2024-07-10T02:28:31Z",
"updatedAt": "2024-07-10T02:28:31Z"
}]
},
"currentCount": 1,
"totalCount": 1,
"totalPage": 1
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明
