接口功能介绍
查询DHCP选项集。
接口约束
无
接口是否审批
否
URI
GET /v4/dhcpoptionsets/query
Content-Type
application/json
路径参数
无
Query参数
| Query参数 | 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池 ID | bb9fdb42056f11eda1610242ac110002 | |
| queryContent | 否 | String | 模糊查询 | test | |
| pageNumber | 否 | Integer | 列表的页码，默认值为 1。 | 1 | |
| pageNo | 否 | Integer | 列表的页码，默认值为 1, 推荐使用该字段, pageNumber 后续会废弃 | 1 | |
| pageSize | 否 | Integer | 分页查询时每页的行数，最大值为 50，默认值为 10。 | 5 |
请求头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 |
| 表 returnObj | 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| results | Array of Objects | dhcpoptionsets组 | results | ||
| totalCount | Integer | 列表条目数 | 20 | ||
| currentCount | Integer | 分页查询时每页的行数。 | 4 | ||
| totalPage | Integer | 总页数 | 5 |
| 表 results | 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| dhcpOptionSetsID | String | dhcpoptionsets ID | |||
| name | String | 名字 | test-1 | ||
| description | String | 描述 | test | ||
| domainName | Array of Strings | 域名 | |||
| dnsList | Array of Strings | ip 列表 | |||
| vpcList | Array of Strings | vpc 列表 | |||
| createdAt | String | 创建时间 | 2024-01-11T08:14:10Z | ||
| updatedAt | String | 更新时间 | 2024-01-11T08:14:10Z |
枚举参数
无
请求头header示例
无
请求url示例
GET /v4/dhcpoptionsets/query?regionID=bb9fdb42056f11eda1610242ac110002
请求体body示例
无
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"results": [
{
"dhcpOptionSetsID": "dopt-t2pxnhf5vk",
"name": "test_wxd0_update",
"description": "test-wxd0",
"domainName": "example.com",
"dnsList": [
"192.168.1.123"
],
"vpcList": [
{
"fuid": "vpc-phgzxfz40h",
"name": "vpc-ebfd16"
}
],
"createdAt": "2024-01-11T07:13:37Z",
"updatedAt": "2024-01-11T08:29:34Z"
},
{
"dhcpOptionSetsID": "dopt-9ae0a7pz2b",
"name": "test_wxd0_dhcp",
"description": "test-wxd0_dhcp",
"domainName": "example.com",
"dnsList": [
"192.168.1.123"
],
"vpcList": [
{
"fuid": "vpc-v6cdypju72",
"name": "dsdf-31gg9f"
}
],
"createdAt": "2024-01-11T08:14:10Z",
"updatedAt": "2024-01-11T08:14:10Z"
}
],
"totalCount": 2,
"totalPage": 1,
"currentCount": 2
}
}
状态码
请参考状态码说明。
错误码
请参考错误码说明。
