查詢資產
更新時間 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},}
狀態碼
請參考
錯誤碼
請參考
