文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 网络/ 查询安全组列表
更新时间：2025-11-05 GMT+08:00
查看PDF
分享

查询安全组列表

功能介绍

该接口查询安全组列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/security-groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Content-Type

是

String

发送的实体的MIME类型，如：application/json。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

security_groups

Array of SecurityGroup objects

安全组列表。
表4 SecurityGroup

参数

参数类型

描述

description

String

安全组描述。

name

String

安全组名称。

id

String

安全组的主键。

security_group_rules

String

外部网关信息。

tenant_id

String

租户主键。

project_id

String

资源租户主键。

created_at

String

资源创建时间。

updated_at

String

资源更新时间。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：405

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：503

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

/v2/0e3f393ae380f5d12facc005678bcd4b/security-groups

响应示例

状态码：200

查询安全组列表响应。

{
  "security_groups" : [ {
    "name" : "WorkspaceUserSecurityGroup",
    "id" : "0822226d-cfc3-4794-957d-e22ccf9d83c6"
  }, {
    "name" : "WorkspaceManagerSecurityGroup",
    "id" : "11b56ad7-3e13-499f-8abe-92b6b68fa613"
  }, {
    "name" : "default",
    "id" : "25f74f8a-e0e6-42a3-b192-a36a2da98c92"
  } ]
}

状态码

状态码

描述

200

查询安全组列表响应。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

服务内部错误，具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码。

父主题： 网络

相关文档