查詢安全組列表v3
更新時間 2025-08-26 16:07:50
最近更新時間: 2025-08-26 16:07:50
分享文章
接口功能介紹
查詢安全組列表v3
接口約束
無
URI
GET /v3/securityGroup/describe
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |
| foreignGroupId | 否 | String | 安全組UUID | ||
| securityGroupName | 否 | String | 安全組名稱 | ||
| pageNum | 否 | Integer | 頁碼，至少1，默認1 | ||
| pageSize | 否 | Integer | 每頁數量，最大100，默認10 |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 狀態碼。可能值： - 800：請求成功。 - 900：請求失敗。 |
800 | |
| error | String | 錯誤碼。 | ECPC_1000 | |
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 返回數據對象 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| total | Long | 總記錄數 | ||
| list | Array of Objects | 數據列表 | list |
表 list
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| securityGroupOid | String | 安全組id | ||
| securityGroupName | String | 安全組名字 | ||
| osSecurityGroupName | String | os側安全組名字 | ||
| foreignGroupId | String | 安全組uuid | ||
| isRelStrategy | Object | 是否關聯策略 | isRelStrategy | |
| remark | String | 描述 | ||
| createDate | Long | 創建時間，unix時間戳（毫秒） | ||
| createStaff | String | 創建角色 | ||
| updateDate | Long | 更新時間，unix時間戳（毫秒） | ||
| updateStaff | String | 更新角色 |
枚舉參數
無
請求示例
請求url
無
請求頭header
無
請求體body
無
響應示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"total":1,
"list":[{
"securityGroupOid":"sg-dtnc9c4debuzvdy1u59pi",
"securityGroupName":"security-5gw6",
"osSecurityGroupName":"security-5gw6--8863904592908452223",
"foreignGroupId":"60a7483e-1a12-4c0b-adf2-b4386e63d5dc",
"isRelStrategy":false,
"remark":"xxxxx",
"createDate":1743040622000,
"createStaff":"usr-69rm1rz65lqk270urf3rw",
"updateDate":1743040622000,
"updateStaff":"usr-69rm1rz65lqk270urf3rw"
}]
}
}
狀態碼
請參考
錯誤碼
請參考
