DescribeSecurityGroups - 查询安全组信息 - 边缘节点服务ENS

调用DescribeSecurityGroups查询已创建的安全组的基本信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ens:DescribeSecurityGroups

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
SecurityGroupId	string	否	安全组 ID。	sg-bp67acfmxazb4ph***
SecurityGroupName	string	否	安全组名称。	DocTest
PageSize	integer	否	分页查询时设置的每页行数。最大值：50。默认值：10。	10
PageNumber	integer	否	安全组列表的页码。起始值：1。默认值：1。	1

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageSize	integer	分页查询时设置的每页行数。	10
PageNumber	integer	安全组列表的页码。	1
TotalCount	integer	分页查询时分页总页数。	49
SecurityGroups	object
SecurityGroup	array<object>	安全组。
	array<object>
CreationTime	string	创建时间。按照 ISO8601 标准表示，并需要使用 UTC 时间。格式为 yyyy-MM-ddTHH:mm:ssZ。	2019-11-01T06:08:46Z
InstanceCount	integer	关联实例数量。	5
Description	string	安全组描述信息。	TestDescription
SecurityGroupId	string	安全组 ID。	sg-bp67acfmxazb4ph***
SecurityGroupName	string	安全组名称。	DocTest
InstanceIds	object
InstanceId	array	安全组绑定的实例 ID 列表。
	string	实例 ID。	i-5****
NetworkInterfaceIds	object
NetworkInterfaceId	array	安全组绑定的弹性网卡 ID 列表。
	string	弹性网卡 ID。	eni-5****

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 49,
  "SecurityGroups": {
    "SecurityGroup": [
      {
        "CreationTime": "2019-11-01T06:08:46Z",
        "InstanceCount": 5,
        "Description": "TestDescription",
        "SecurityGroupId": "sg-bp67acfmxazb4ph***",
        "SecurityGroupName": "DocTest",
        "InstanceIds": {
          "InstanceId": [
            "i-5****"
          ]
        },
        "NetworkInterfaceIds": {
          "NetworkInterfaceId": [
            "eni-5****"
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	NoPermission	Permission denied.
400	CallInterface	Call Interface Happen Error.	接口调用出错。
400	ens.interface.error	Failed to call API.	接口调用发生异常。
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。