查询安全组列表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"
}]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
