查询资产
更新时间 2024-12-05 17:31:11
最近更新时间: 2024-12-05 17:31:11
接口功能介绍
查询资产接口
接口约束
传参规范
URI
GET /vfw/v2_system_vrf_bind_query
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| attachedType | 否 | String | 绑定设备类型 INSTANCE-云主机 | ||
| eip | 否 | String | eip | ||
| eipId | 否 | String | eipId | ||
| eipName | 否 | String | eip名称 | ||
| filterTip | 否 | Boolean | 过滤提示 | ||
| firewallId | 否 | String | 防火墙ID | ||
| ipType | 否 | String | IP类型，ipv4;ipv6; | ||
| page | 否 | Integer | 页码 | 1 | |
| protectStatus | 否 | Boolean | 防护状态 | ||
| size | 否 | Integer | 条数 | 1 | |
| subnetId | 否 | String | 子网id | ||
| subnetIds | 否 | Array of Strings | 子网id列表 | ||
| vpcId | 否 | String | vpc id | ||
| vpcIp | 否 | String | vpc ip | ||
| vpcName | 否 | String | vpc名称 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| urlType | 是 | String | 请求地址类型 | CTAPI | |
| regionId | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 状态码 | ||
| message | String | 返回信息 | 成功 | |
| error | String | 错误码：CFW_0000 :成功!;CFW_0001:参数错误！;CFW_0002：业务错误！ | CFW_0000 | |
| returnObj | Object | 接口返回结果 | PageInfo |
表 PageInfo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| endRow | Long | 当前页面最后一个元素在数据库中的行号 | ||
| hasNextPage | Boolean | 是否有下一页 | ||
| hasPreviousPage | Boolean | 是否有前一页 | ||
| isFirstPage | Boolean | 是否为首页 | ||
| isLastPage | Boolean | 是否为末页 | ||
| list | Array of Objects | 资产列表 | ListEntity | |
| navigateFirstPage | Integer | 导航条上的第一页 | 1 | |
| navigateLastPage | Integer | 导航条上的最后一页 | 1 | |
| navigatePages | Integer | 导航页码数 | 1 | |
| navigatepageNums | Array of Integers | 所有导航页号 | 1 | |
| nextPage | Integer | 下一页 | 1 | |
| pageNum | Integer | 当前页的页码 | 1 | |
| pageSize | Integer | 每页的数量 | 1 | |
| pages | Integer | 总页数 | 1 | |
| prePage | Integer | 前一页 | 1 | |
| size | Integer | 当前页的数量 | 1 | |
| startRow | Long | 当前页面第一个元素在数据库中的行号 | ||
| total | Long | 总记录数 |
表 ListEntity
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| attachedId | String | 绑定设备ID | aab10b21-1ec0-4010-8b16-d76993b49d9b | |
| attachedName | String | 绑定设备名称 | as-config-b17cqes8 | |
| attachedPrivateIp | String | 绑定设备ip | 172.31.0.150 | |
| attachedType | String | 绑定设备类型 VM-云主机 BM-物理机 VIP-虚拟ip LB-是负载均衡，BM;LB;NAT;VIP;VM; | VM | |
| bindStatus | String | 绑定状态，bind;unbind; | bind | |
| eip | String | eip | 182.43.62.56 | |
| eipId | String | eipId | eip-p0weypef75 | |
| eipName | String | eip名称 | eip-1cc7 | |
| eipNum | String | eip数字形式表现 | ||
| firewallEdition | String | 防火墙版本号 | ||
| firewallId | String | 防火墙ID | ||
| ipType | String | IP类型，ipv4;ipv6; | ipv4 | |
| protectStatus | Boolean | 防护状态 | ||
| regionId | String | 资源池ID | a6449feab4db11e9a6b40242ac110007 | |
| subnetCidr | String | 子网cidr | ||
| subnetId | String | 子网id | ||
| subnetName | String | 子网名称 | ||
| tip | String | 提示 normal-正常 tipOpenFirewall-提示开通防火墙 tipConfig-提示更改配置 | ||
| uid | String | 租户ID | 6ee4c9fa71c3403eab8af44e29c3e4c1 | |
| userId | String | 用户id | 6ee4c9fa71c3403eab8af44e29c3e4c1 | |
| vpcId | String | vpc id | vpc-cc91 | |
| vpcIp | String | vpc ip | 192.168.0.0/16 | |
| vpcName | String | vpc名称 | vpc-cc91 | |
| endpoint | Object | 终端节点 | GwlbeInfoVo |
表 GwlbeInfoVo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| endpointName | String | 终端节点名称 | ||
| endpointId | String | 终端节点id | ||
| vpcName | String | Vpc名称 | ||
| subnetName | String | 子网名称 | ||
| description | String | 描述 |
枚举参数
无
请求示例
请求url
无
请求头header
{
"regionid": "100054c0416811e9a6690242ac110002",
"urlType": "CTAPI"
}
请求体body
{}
响应示例
{"statusCode": "200","error": "CFW_0000","message": "成功!","returnObj": {"endRow": 0,"hasNextPage": false,"hasPreviousPage": false,"isFirstPage": false,"isLastPage": false,"list": [{"attachedId": "aab10b21-1ec0-4010-8b16-d76993b49d9b","attachedName": "as-config-b17cqes8","attachedPrivateIp": "172.31.0.150","attachedType": "VM","bindStatus": "bind","eip": "182.43.62.56","eipId": "eip-p0weypef75","eipName": "eip-1cc7","eipNum": "","firewallEdition": "","firewallId": "","ipType": "ipv4","protectStatus": false,"regionId": "a6449feab4db11e9a6b40242ac110007","subnetCidr": "","subnetId": "","subnetName": "","tip": "","uid": "6ee4c9fa71c3403eab8af44e29c3e4c1","userId": "6ee4c9fa71c3403eab8af44e29c3e4c1","vpcId": "vpc-cc91","vpcIp": "192.168.0.0/16","vpcName": "vpc-cc91"}],"navigateFirstPage": 0,"navigateLastPage": 0,"navigatePages": 0,"navigatepageNums": [],"nextPage": 0,"pageNum": 0,"pageSize": 0,"pages": 0,"prePage": 0,"size": 0,"startRow": 0,"total": 0},}
状态码
请参考 状态码
错误码
请参考 错误码
