查詢虛機網卡與可綁定安全組信息v3
更新時間 2025-08-26 16:07:36
最近更新時間: 2025-08-26 16:07:36
分享文章
接口功能介紹
查詢虛機網卡與可綁定安全組信息v3
接口約束
無
URI
GET /v3/securityGroup/desktop/describe
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池ID | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |
| desktopOid | 是 | String | 虛機ID |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 狀態碼。可能值： - 800：請求成功。 - 900：請求失敗。 |
800 | |
| error | String | 錯誤碼。 | ECPC_1000 | |
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 返回數據對象 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| portList | Array of Objects | 虛機網卡信息，當portOid為0，代表全部網卡 | portList | |
| securityGroupList | Array of Objects | 虛機可綁定安全組信息 | securityGroupList | |
| portSgList | Array of Objects | 虛機網卡和安全組的關聯，portOid為0時代表全部網卡 | portSgList |
表 portList
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| portOid | String | 網卡id | ||
| portName | String | 網卡名稱 | ||
| portNickName | String | 網卡別名 | ||
| ipAddress | String | 網卡IP | ||
| subnetName | String | 所屬子網名稱 |
表 securityGroupList
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| securityGroupOid | String | 安全組id | ||
| securityGroupName | String | 安全組名稱 |
表 portSgList
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| portOid | String | 網卡id | ||
| securityGroupOid | String | 安全組id |
枚舉參數
無
請求示例
請求url
無
請求頭header
無
請求體body
無
響應示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"portList":[{
"portOid":"port-ggpgxz5n5nhmro3fw34jg",
"portName":"port_vpcId_17265_vm_1321395_1745480811629_master",
"portNickName":"port_vpcId_17265_vm_1321395_1745480811629_master",
"ipAddress":"192.168.0.43",
"subnetName":"子網1"
}],
"securityGroupList":[{
"securityGroupOid":"sg-774amh5cwx61fw8rfv7c1",
"securityGroupName":"security-apitest"
}],
"portSgList":[{
"portOid":"port-ggpgxz5n5nhmro3fw34jg",
"securityGroupOid":"sg-des9ihmdrpas8pdge4e4l"
}]
}
}
狀態碼
請參考
錯誤碼
請參考
