DescribeSecurityGroups_云服务器 ECS_API文档

2014-05-26

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

分页查询：推荐您使用MaxResults与NextToken参数进行查询。
- 当返回结果中没有NextToken时，表示该页为末页，不再有后续页。
- 分页查询首页时，仅需设置MaxResults以限制返回信息的条目数，返回结果中的NextToken将作为查询后续页的凭证。
- 查询后续页时，将NextToken参数设置为上一次返回结果中获取到的NextToken作为查询凭证，并设置MaxResults限制返回条目数。
通过阿里云 CLI 调用 API 时，不同数据类型的请求参数取值必须遵循一定的格式要求。更多信息，请参见 CLI 参数格式说明。

流控信息

请求速率为1000/60(s)。更多流控信息，请前往配额中心查看

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

ecs:DescribeSecurityGroups	Get	SecurityGroup acs:ecs:{#regionId}:{#accountId}:securitygroup/* SecurityGroup acs:ecs:{#regionId}:{#accountId}:securitygroup/{#securitygroupId}	ecs:tag ecs:tag ecs:tag ecs:tag	无

请求参数

字段名称	字段详情
RegionIdstring	地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。示例值:cn-hangzhou参考取值来源: DescribeRegions
SecurityGroupIdsstring	安全组 ID 列表。一次最多支持 100 个安全组 ID，ID 之间用半角逗号（,）隔开，格式为 JSON 数组。示例值:["sg-bp67acfmxazb4p**", "sg-bp67acfmxazb4p", "sg-bp67acfmxazb4p**",....]参考取值来源: CreateSecurityGroup DescribeSecurityGroupAttribute
VpcIdstring	安全组所在的专有网络 ID。示例值:vpc-bp67acfmxazb4p****
SecurityGroupTypestring	安全组类型。取值范围：展开详情示例值:normal
NextTokenstring	查询凭证（Token）。取值为上一次调用该接口返回的 NextToken 参数值，初次调用接口时无需设置该参数。示例值:e71d8a535bd9cc11
MaxResultsinteger<int32>	分页查询时每页的最大条目数。一旦设置该参数，即表示使用`MaxResults`与`NextToken`组合参数的查询方式。展开详情示例值:10取值 <= 100
NetworkTypestring	安全组的网络类型。取值范围：展开详情示例值:vpc
SecurityGroupNamestring	安全组名称。示例值:SGTestName参考取值来源: DescribeSecurityGroupAttribute
IsQueryEcsCountboolean	是否查询安全组的容量信息。传 True 时，返回值中的`EcsCount`和`AvailableInstanceAmount`有效。展开详情示例值:null
ResourceGroupIdstring	安全组所在的企业资源组 ID。使用该参数过滤资源时，资源数量不能超过 1000 个。您可以调用 ListResourceGroups 查询资源组列表。展开详情示例值:rg-bp67acfmxazb4p****参考取值来源: DescribeSnapshotGroups
Tagarray<object>	标签列表。子级条数 <= 20
DryRunboolean	是否只预检此次请求。取值范围：展开详情示例值:false
SecurityGroupIdstring	安全组 ID。示例值:sg-bp67acfmxazb4p****参考取值来源: CreateSecurityGroup
FuzzyQueryboolean	说明该参数已废弃。示例值:null
PageNumberinteger<int32>	说明该参数即将下线，推荐您使用 NextToken 与 MaxResults 完成分页查询操作。示例值:1取值 >= 1
PageSizeinteger<int32>	说明该参数即将下线，推荐您使用 NextToken 与 MaxResults 完成分页查询操作。示例值:10取值 <= 100
ServiceManagedboolean	是否为托管安全组。取值范围：展开详情示例值:false

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
RegionIdstring	安全组所属地域 ID。示例值:cn-hangzhou
NextTokenstring	本次调用返回的查询凭证（Token）。当使用 MaxResults 和 NextToken 方式进行分页查询，且该返回值为空时，表示无更多返回的数据信息。示例值:e71d8a535bd9cc11
SecurityGroupsobject
TotalCountinteger<int32>	安全组的总数。当您使用`MaxResults`与`NextToken`参数查询时，不会返回该参数值。示例值:20
PageNumberinteger<int32>	当前页码。展开详情示例值:1
PageSizeinteger<int32>	每页行数。展开详情示例值:10

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	NotSupported.PageNumberAndPageSize	The parameters PageNumber and PageSize are currently not supported, please use NextToken and MaxResults instead.	诊断
400	InValidParameter.NextToken	The parameter NextToken is invalid.	诊断
400	MissingParameter.RegionId	The input parameter RegionId that is mandatory for processing this request is not supplied.	诊断
400	InvalidParameter.SecurityGroupType	The specified SecurityGroupType is not valid.	诊断
400	InvalidSecurityGroupId.Malformed	The specified parameter SecurityGroupId is not valid.	诊断
400	InvalidSecurityGroupName.Malformed	The specified parameter SecurityGroupName is not valid.	诊断
500	InternalError	The request processing has failed due to some unknown error.	诊断

变更历史

	变更时间	变更内容概要	操作
	2024-09-23	变更错误码400 变更返回参数
	2023-11-14	新增请求参数ServiceManaged
	2023-04-07	变更错误码400
	2021-12-05	变更错误码400
	2021-10-12	变更请求参数MaxResults

相关示例

查询创建ECS所需要的资源信息

查询创建 ECS 需要的资源信息详情

2021-01-05