查询安全组列表
功能介绍
查询某租户下的安全组列表。
接口约束
查询提交请求的租户有权限查看的所有安全组信息，单次查询最多返回2000条数据，超过2000后会返回分页标记
URI
GET /v3/{project_id}/vpc/security-groups
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 获取方法请参见获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
功能说明：每页返回的个数 取值范围：0-2000 |
|
marker |
否 |
String |
分页查询起始的资源ID，为空时查询第一页 |
|
id |
否 |
String |
功能说明：安全组资源ID。可以使用该字段精确过滤安全组，支持多个ID |
|
name |
否 |
Array of strings |
功能说明：安全组名称。可以使用该字段精确过滤满足条件的安全组，支持传入多个name过滤 |
|
description |
否 |
Array of strings |
功能说明：安全组描述新增。可以使用该字段精确过滤安全组，支持传入多个描述进行过滤 |
请求参数
无
请求示例
- 查询安全组列表
"GET https://{Endpoint}/v3/{project_id}/vpc/security-groups"
响应参数
状态码为 200 时:
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
security_groups |
Array of SecurityGroup objects |
安全组列表响应体 |
|
request_id |
String |
请求ID |
|
page_info |
PageInfo object |
分页信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
功能描述：安全组对应的唯一标识 取值范围：带“-”的标准UUID格式 |
|
name |
String |
功能说明：安全组名称 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点） |
|
description |
String |
功能说明：安全组的描述信息 取值范围：0-255个字符，不能包含“<”和“>” |
|
project_id |
String |
功能说明：安全组所属的项目ID |
|
created_at |
String |
功能说明：安全组创建时间 取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ss |
|
updated_at |
String |
功能说明：安全组更新时间 取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ss |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
previous_marker |
String |
当前页第一条记录 |
|
current_count |
Integer |
当前页总数 |
|
next_marker |
String |
当前页最后一条记录,最后一页时无next_marker字段 |
状态码为 400 时:
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求ID |
|
error_msg |
String |
错误消息 |
|
error_code |
String |
错误码 |
状态码为 401 时:
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求ID |
|
error_msg |
String |
错误消息 |
|
error_code |
String |
错误码 |
状态码为 403 时:
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求ID |
|
error_msg |
String |
错误消息 |
|
error_code |
String |
错误码 |
状态码为 500 时:
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求ID |
|
error_msg |
String |
错误消息 |
|
error_code |
String |
错误码 |
响应示例
状态码为 200 时:
{
"request_id": "d31cb32ca06f3c1a294fa24e6cbc5a56",
"security_groups": [
{
"id": "0552091e-b83a-49dd-88a7-4a5c86fd9ec3",
"name": "Sys-FullAccess--",
"project_id": "060576782980d5762f9ec014dd2f1148",
"description": "~!@#¥",
"created_at": "2019-10-16T11:11:14Z",
"updated_at": "2020-03-25T10:53:46Z"
},
{
"id": "0b8cb773-197c-4c91-94f1-e051f0563e5a",
"name": "test-sg",
"project_id": "060576782980d5762f9ec014dd2f1148",
"description": "通用Web服务器,默认放通22、3389、80、443端口和ICMP协议。适用于需要远程登录、公网ping及用于网站服务的云服务器场景。",
"created_at": "2019-12-03T09:02:11Z",
"updated_at": "2019-12-03T09:02:11Z"
}
],
"page_info": {
"previous_marker": "0552091e-b83a-49dd-88a7-4a5c86fd9ec3",
"current_count": 2
}
}
状态码
请参见状态码。
错误码
请参见错误码。
