DescribeSecurityGroups - 查询安全组的基本信息_云服务器 ECS(ECS)-阿里云帮助中心

查询您创建的安全组的基本信息。

接口说明

调用接口前，您需要注意：

安全组的基本信息包括安全组 ID 和安全组描述等。返回参数列表按照安全组 ID 降序排列。
在分页查询时，推荐您使用MaxResults与NextToken参数进行查询。具体使用说明：分页查询首页时，仅需设置MaxResults以限制返回信息的条目数，返回结果中的NextToken将作为查询后续页的凭证。查询后续页时，将NextToken参数设置为上一次返回结果中获取到的NextToken作为查询凭证，并设置MaxResults限制返回条目数。当返回结果中的NextToken为空时，表示该页为末页，不再有后续页。
通过阿里云 CLI 调用 API 时，不同数据类型的请求参数取值必须遵循一定的格式要求。更多信息，请参见 CLI 参数格式说明。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
ecs:DescribeSecurityGroups	get	SecurityGroup `acs:ecs:{#regionId}:{#accountId}:securitygroup/` *SecurityGroup `acs:ecs:{#regionId}:{#accountId}:securitygroup/{#securitygroupId}`	ecs:tag	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
SecurityGroupIds	string	否	安全组 ID 列表。一次最多支持 100 个安全组 ID，ID 之间用半角逗号（,）隔开，格式为 JSON 数组。	["sg-bp67acfmxazb4p**", "sg-bp67acfmxazb4p", "sg-bp67acfmxazb4p**",....]
VpcId	string	否	安全组所在的专有网络 ID。	vpc-bp67acfmxazb4p****
SecurityGroupType	string	否	安全组类型。取值范围： normal：普通安全组。 enterprise：企业安全组。说明当不为该参数传值时，表示查询所有类型的安全组。	normal
NextToken	string	否	查询凭证（Token）。取值为上一次调用该接口返回的 NextToken 参数值，初次调用接口时无需设置该参数。	e71d8a535bd9cc11
MaxResults	integer	否	分页查询时每页的最大条目数。一旦设置该参数，即表示使用`MaxResults`与`NextToken`组合参数的查询方式。最大值为 100。默认值为 10。	10
NetworkType	string	否	安全组的网络类型。取值范围： vpc：专有网络。 classic：经典网络。	vpc
SecurityGroupName	string	否	安全组名称。	SGTestName
IsQueryEcsCount	boolean	否	是否查询安全组的容量信息。传 True 时，返回值中的`EcsCount`和`AvailableInstanceAmount`有效。说明该参数已废弃。	null
ResourceGroupId	string	否	安全组所在的企业资源组 ID。使用该参数过滤资源时，资源数量不能超过 1000 个。您可以调用 ListResourceGroups 查询资源组列表。说明不支持默认资源组过滤。	rg-bp67acfmxazb4p****
Tag	array<object>	否	标签列表。
	object	否	标签列表。
key	string	否	安全组的标签键。说明为提高兼容性，建议您尽量使用 Tag.N.Key 参数。	testkey
Key	string	否	安全组的标签键。N 的取值范围为 1~20。使用一个标签过滤资源，查询到该标签下的资源数量不能超过 1000 个；使用多个标签过滤资源，查询到同时绑定了多个标签的资源数量不能超过 1000 个。如果资源数量超过 1000 个，请使用 ListTagResources 接口进行查询。	TestKey
Value	string	否	安全组的标签值。N 的取值范围：1~20。	TestValue
value	string	否	安全组的标签值。说明为提高兼容性，建议您尽量使用 Tag.N.Value 参数。	testvalue
DryRun	boolean	否	是否只预检此次请求。取值范围： true：发送检查请求，不会查询资源状况。检查项包括 AccessKey 是否有效、RAM 用户的授权情况和是否填写了必需参数。如果检查不通过，则返回对应错误。如果检查通过，会返回错误码 DryRunOperation。 false：发送正常请求，通过检查后返回 2XX HTTP 状态码并直接查询资源状况。默认值为 false。	false
SecurityGroupId	string	否	安全组 ID。	sg-bp67acfmxazb4p****
FuzzyQuery	boolean	否	说明该参数已废弃。	null
PageNumber	integer	否	安全组列表的页码。起始值为 1。默认值为 1。说明该参数即将下线，推荐您使用 NextToken 与 MaxResults 完成分页查询操作。	1
PageSize	integer	否	分页查询时设置的每页行数。最大值为 50。默认值为 10。说明该参数即将下线，推荐您使用 NextToken 与 MaxResults 完成分页查询操作。	10
ServiceManaged	boolean	否	是否为托管安全组。取值范围： true：是托管安全组。 false：不是托管安全组。	false

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
RegionId	string	安全组所属地域 ID。	cn-hangzhou
NextToken	string	本次调用返回的查询凭证（Token）。当使用 MaxResults 和 NextToken 方式进行分页查询，且该返回值为空时，表示无更多返回的数据信息。	e71d8a535bd9cc11
SecurityGroups	array<object>	安全组信息集合。
SecurityGroup	object
SecurityGroupId	string	安全组 ID。	sg-bp67acfmxazb4p****
SecurityGroupName	string	安全组名称。	SGTestName
Description	string	安全组描述信息。	TestDescription
SecurityGroupType	string	安全组类型。可能值： normal：普通安全组。 enterprise：企业安全组。	normal
VpcId	string	安全组所属的专有网络。	vpc-bp67acfmxazb4p****
CreationTime	string	创建时间。按照ISO 8601标准表示，并需要使用 UTC 时间。格式为：yyyy-MM-ddThh:mmZ。	2021-08-31T03:12:29Z
EcsCount	integer	安全组中已经容纳的私网 IP 数量，参见安全组容量。当入参 IsQueryEcsCount 传入 True 时，该参数返回值有效。说明该参数已废弃。返回值中的数量仅供参考，非实时一致。	0
AvailableInstanceAmount	integer	安全组中还可加入的私网 IP 数量，参见安全组容量。当入参 IsQueryEcsCount 传入 True 时，该参数返回值有效。说明该参数已废弃。返回值中的数量仅供参考，非实时一致。	0
ResourceGroupId	string	安全组所在的企业资源组 ID。	rg-bp67acfmxazb4p****
ServiceManaged	boolean	安全组的使用者是否为云产品或虚商。	false
ServiceID	long	安全组对应的虚商 ID。	12345678910
Tags	array<object>	安全组的标签。
Tag	object
TagValue	string	安全组的标签值。	TestValue
TagKey	string	安全组的标签键。	TestKey
RuleCount	integer	安全组中的规则数量。	100
GroupToGroupRuleCount	integer	安全组中授权安全组访问的规则数量。	5
TotalCount	integer	安全组的总数。当您使用`MaxResults`与`NextToken`参数查询时，不会返回该参数值。	20
PageNumber	integer	当前页码。说明该参数即将下线，推荐您使用 NextToken 与 MaxResults 完成分页查询操作。	1
PageSize	integer	每页行数。说明该参数即将下线，推荐您使用 NextToken 与 MaxResults 完成分页查询操作。	10

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "RegionId": "cn-hangzhou",
  "NextToken": "e71d8a535bd9cc11",
  "SecurityGroups": {
    "SecurityGroup": [
      {
        "SecurityGroupId": "sg-bp67acfmxazb4p****",
        "SecurityGroupName": "SGTestName",
        "Description": "TestDescription",
        "SecurityGroupType": "normal",
        "VpcId": "vpc-bp67acfmxazb4p****",
        "CreationTime": "2021-08-31T03:12:29Z",
        "EcsCount": 0,
        "AvailableInstanceAmount": 0,
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "ServiceManaged": false,
        "ServiceID": 12345678910,
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "RuleCount": 100,
        "GroupToGroupRuleCount": 5
      }
    ]
  },
  "TotalCount": 20,
  "PageNumber": 1,
  "PageSize": 10
}

错误码

HTTP status code	错误码	错误信息	描述
400	NotSupported.PageNumberAndPageSize	The parameters PageNumber and PageSize are currently not supported, please use NextToken and MaxResults instead.	参数PageNumber和PageSize已经不受支持，请使用参数NextToken和MaxResults。
400	InValidParameter.NextToken	The parameter NextToken is invalid.	指定的参数NextToken不合法。
400	MissingParameter.RegionId	The input parameter RegionId that is mandatory for processing this request is not supplied.	参数 RegionId 不能为空。
400	InvalidParameter.SecurityGroupType	The specified SecurityGroupType is not valid.	指定的 SecurityGroupType 参数无效，请检查该参数取值是否正确。
400	InvalidSecurityGroupId.Malformed	The specified parameter SecurityGroupId is not valid.	指定的参数 SecurityGroupId 无效。
400	InvalidSecurityGroupName.Malformed	The specified parameter SecurityGroupName is not valid.	指定的安全组名称格式不合法。请您按照规则进行配置：默认值为空，长度为 2-128 个英文或中文字符，必须以大小字母或中文开头，可包含数字，英文句号（.），下划线（_）或连字符（-），安全组名称会展示在控制台。不能以 http:// 和 https:// 开头。
500	InternalError	The request processing has failed due to some unknown error.	内部错误，请重试。

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

变更历史

变更时间	变更内容概要	操作
2024-09-23	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-11-14	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2023-04-07	OpenAPI 错误码发生变更	查看变更详情
2021-12-05	OpenAPI 错误码发生变更	查看变更详情
2021-10-12	OpenAPI 错误码发生变更	查看变更详情