查询您创建的安全组的基本信息,例如安全组ID和安全组描述等。返回列表按照安全组ID降序排列。

调试

前往【API Explorer】在线调试,API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力,能显著降低使用云 API 的难度,强烈推荐使用。

请求参数

名称 类型 是否必选 示例值 描述
RegionId String cn-hangzhou

地域ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

Action String DescribeSecurityGroups

系统规定参数。取值:DescribeSecurityGroups

DryRun Boolean false

是否只预检此次请求。

  • true:发送检查请求,不会查询资源状况。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。如果检查不通过,则返回对应错误。如果检查通过,会返回错误码DryRunOperation。
  • false:发送正常请求,通过检查后返回2XX HTTP状态码并直接查询资源状况。

默认值:false

NetworkType String vpc

网络类型。

PageNumber Integer 1

安全组列表的页码。起始值:1

默认值:1

PageSize Integer 10

分页查询时设置的每页行数。最大值:50

默认值:10

ResourceGroupId String rg-resourcegroupid1

安全组所在的企业资源组 ID。

SecurityGroupId String sg-securitygroupid

安全组ID。

SecurityGroupIds String ["sg-id1", "sg-id2", "sg-id2",....]

安全组ID列表。一次最多支持100个安全组ID,ID之间用半角逗号(,)隔开,格式为JSON数组。

SecurityGroupName String test1

安全组名称。

Tag.N.Key String FinanceDept

安全组的标签键。N 的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持 64 个字符,不能以 aliyun 和 acs: 开头,不能包含 http:// 或者 https:// 。

Tag.N.Value String FinanceJoshua

安全组的标签值。N 的取值范围:1~20。一旦传入该值,可以为空字符串。最多支持 128 个字符,不能以 aliyun 和 acs: 开头,不能包含 http:// 或者 https:// 。

Tag.N.key String FinanceDept

安全组的标签键。

说明 该参数即将被弃用,为提高兼容性,建议您尽量使用Tag.N.Key参数。
Tag.N.value String FinanceJoshua

安全组的标签值。n的取值范围为 1~20。一旦传入该值,可以为空字符串。最多支持 128 个字符,不能以 aliyun、acs:、http:// 或者 https:// 开头。

说明 该参数即将被弃用,为提高兼容性,建议您尽量使用Tag.N.Value参数。
VpcId String vpc-vpcid1

安全组所在的专有网络ID。

返回参数

名称 类型 示例值 描述
PageNumber Integer 1

当前页码

PageSize Integer 10

每页行数

RegionId String cn-hangzhou

安全组所属地域ID

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求 ID

SecurityGroups

安全组信息集合

  └CreationTime String 2017-12-05T22:40:00Z

创建时间。按照 ISO8601 标准表示,并需要使用UTC时间。格式为:yyyy-MM-ddThh:mmZ

  └Description String FinanceDept

描述信息

  └ResourceGroupId String rg-resourcegroupid1

安全组所在的企业资源组 ID。

  └SecurityGroupId String sg-securitygroupid1

安全组ID

  └SecurityGroupName String FinanceJoshua

安全组名称

  └Tags

安全组的标签。

    └TagKey String FinanceDept

安全组的标签键。

    └TagValue String FinanceJoshua

安全组的标签值。

  └VpcId String vpc-vpcid1

安全组所属的专有网络

TotalCount Integer 4

安全组的总数

示例

请求示例


https://ecs.aliyuncs.com/?Action=DescribeSecurityGroups
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式

<DescribeSecurityGroupsResponse>
  <RequestId>94D38899-626D-434A-891F-7E1F77A81525</RequestId>
  <TotalCount>4</TotalCount>
  <PageNumber>1</PageNumber>
  <PageSize>10</PageSize>
  <RegionId>cn-hangzhou</RegionId>
  <SecurityGroups>
    <SecurityGroup>
      <SecurityGroupId>sg-F876FF7BA</SecurityGroupId>
      <Description>Test</Description>
    </SecurityGroup>
    <SecurityGroup>
      <SecurityGroupId>sg-086FFC27A</SecurityGroupId>
      <Description>test00212</Description>
    </SecurityGroup>
    <SecurityGroup>
      <SecurityGroupId>sg-BA4B7975B</SecurityGroupId>
      <Description>cn-hangzhou test group</Description>
    </SecurityGroup>
    <SecurityGroup>
      <SecurityGroupId>sg-35F20777C</SecurityGroupId>
      <Description>cn-hangzhou test group</Description>
    </SecurityGroup>
  </SecurityGroups>
</DescribeSecurityGroupsResponse>

JSON 格式

{
	"PageNumber":"1",
	"TotalCount":4,
	"PageSize":"10",
	"RegionId":"cn-hangzhou",
	"RequestId":"94D38899-626D-434A-891F-7E1F77A81525",
	"SecurityGroups":{
		"SecurityGroup":[
			{
				"SecurityGroupId":"sg-F876FF7BA",
				"Description":"TestByXcf"
			},
			{
				"SecurityGroupId":"sg-086FFC27A",
				"Description":"test00212"
			},
			{
				"SecurityGroupId":"sg-BA4B7975B",
				"Description":"cn-hangzhou test group"
			},
			{
				"SecurityGroupId":"sg-35F20777C",
				"Description":"cn-hangzhou test group"
			}
		]
	}
}

错误码

HttpCode 错误码 错误信息 描述
500 InternalError The request processing has failed due to some unknown error. 内部错误,请重试。如果多次尝试失败,请提交工单

查看本产品错误码