查询虚机网卡与可绑定安全组信息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"
}]
}
}
状态码
请参考 状态码
错误码
请参考 错误码