接口功能介绍
创建前缀列表。
接口约束
无
URI
POST /openapi/v4/prefixlist/create
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| name | 是 | String | 支持拉丁字母、中文、数字，下划线，连字符，中文 / 英文字母开头，不能以 http: / https: 开头，长度 2 - 32 | pl-l11 | |
| description | 否 | String | 支持拉丁字母、中文、数字, 特殊字符：~ !@#$%^&*()_-+= <>?:"{},./;'[]·~！@#￥%……&*（） —— -+={}|《》？：“”【】、；‘'，。、，不能以 http: / https: 开头，长度 0 - 128 | prefixlist | |
| limit | 是 | Integer | 前缀列表支持的最大条目容量，创建后将无法修改,限制1-200条，具体以账户配额为准,不能小于前缀列表规则个数 | 10 | |
| addressType | 是 | Integer | 地址类型，4：ipv4，6：ipv6 | 4 | |
| prefixListRules | 是 | Array of Objects | 接口业务数据 | 见下表 | prefixListRules |
表 prefixListRules
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| cidr | 是 | String | 前缀列表条目,cidr | 192.1.0.0/16 |
| description | 否 | String | 支持拉丁字母、中文、数字, 特殊字符：~ !@#$%^&*()_-+= <>?:"{},./;'[]·~！@#￥%……&*（） —— -+={}|《》？：“”【】、；‘'，。、，不能以 http: / https: 开头，长度 0 - 128 | test |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| prefixListID | String | prefixlist id | pl-qqhvysp19c |
请求示例
请求url
POST /openapi/v4/prefixlist/create
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"name": "tets_xxx111",
"description": "xxx123",
"addressType": 4,
"limit": 4,
"prefixListRules": [
{
"cidr": "10.1.0.0/23",
"description": "sdwe"
}
]
}
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"prefixListID": "pl-qqhvysp19c"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
