DescribeSecurityGroups
Query and retrieve detailed information about security groups in Alibaba Cloud, filtering by region, ID, type, or network to manage and inspect security configurations effectively.
Instructions
本接口用于查询安全组基本信息列表,支持您通过地域、安全组ID、安全组类型等不同参数查询。
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| DryRun | No | 是否只预检此次请求。取值范围: - true:发送检查请求,不会查询资源状况。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。如果检查不通过,则返回对应错误。如果检查通过,会返回错误码DryRunOperation。 - false:发送正常请求,通过检查后返回2XX HTTP状态码并直接查询资源状况。 默认值为false。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: boolean,参数示例:false | |
| FuzzyQuery | No | >该参数已废弃。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: boolean,参数示例:null | |
| IsQueryEcsCount | No | 是否查询安全组的容量信息。传True时,返回值中的`EcsCount`和`AvailableInstanceAmount`有效。 >该参数已废弃。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: boolean,参数示例:null | |
| MaxResults | No | 分页查询时每页的最大条目数。一旦设置该参数,即表示使用`MaxResults`与`NextToken`组合参数的查询方式。 最大值为100。 默认值为10。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: integer,参数示例:10 | |
| NetworkType | No | 安全组的网络类型。取值范围: - vpc:专有网络。 - classic:经典网络。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:vpc | |
| NextToken | No | 查询凭证(Token)。取值为上一次调用该接口返回的NextToken参数值,初次调用接口时无需设置该参数。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:e71d8a535bd9cc11 | |
| PageNumber | No | > 该参数即将下线,推荐您使用NextToken与MaxResults完成分页查询操作。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: integer,参数示例:1 | |
| PageSize | No | > 该参数即将下线,推荐您使用NextToken与MaxResults完成分页查询操作。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: integer,参数示例:10 | |
| RegionId | Yes | 地域ID。您可以调用[DescribeRegions](~~25609~~)查看最新的阿里云地域列表。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:cn-hangzhou | |
| ResourceGroupId | No | 安全组所在的企业资源组ID。使用该参数过滤资源时,资源数量不能超过1000个。您可以调用[ListResourceGroups](~~158855~~)查询资源组列表。 >不支持默认资源组过滤。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:rg-bp67acfmxazb4p**** | |
| SecurityGroupId | No | 安全组ID。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:sg-bp67acfmxazb4p**** | |
| SecurityGroupIds | No | 安全组ID列表。一次最多支持100个安全组ID,ID之间用半角逗号(,)隔开,格式为JSON数组。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:["sg-bp67acfmxazb4p****", "sg-bp67acfmxazb4p****", "sg-bp67acfmxazb4p****",....] | |
| SecurityGroupName | No | 安全组名称。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:SGTestName | |
| SecurityGroupType | No | 安全组类型。取值范围: - normal:普通安全组。 - enterprise:企业安全组。 > 当不为该参数传值时,表示查询所有类型的安全组。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:normal | |
| ServiceManaged | No | 是否为托管安全组。取值范围: - true:是托管安全组。 - false:不是托管安全组。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: boolean,参数示例:false | |
| Tag | No | 标签列表。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: array,参数示例: | |
| VpcId | No | 安全组所在的专有网络ID。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:vpc-bp67acfmxazb4p**** |
Input Schema (JSON Schema)
{
"properties": {
"DryRun": {
"default": null,
"description": "是否只预检此次请求。取值范围:\n \n- true:发送检查请求,不会查询资源状况。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。如果检查不通过,则返回对应错误。如果检查通过,会返回错误码DryRunOperation。\n- false:发送正常请求,通过检查后返回2XX HTTP状态码并直接查询资源状况。\n\n默认值为false。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: boolean,参数示例:false",
"title": "Dryrun",
"type": "boolean"
},
"FuzzyQuery": {
"default": null,
"description": ">该参数已废弃。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: boolean,参数示例:null",
"title": "Fuzzyquery",
"type": "boolean"
},
"IsQueryEcsCount": {
"default": null,
"description": "是否查询安全组的容量信息。传True时,返回值中的`EcsCount`和`AvailableInstanceAmount`有效。\n>该参数已废弃。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: boolean,参数示例:null",
"title": "Isqueryecscount",
"type": "boolean"
},
"MaxResults": {
"default": null,
"description": "分页查询时每页的最大条目数。一旦设置该参数,即表示使用`MaxResults`与`NextToken`组合参数的查询方式。\n\n最大值为100。\n\n默认值为10。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: integer,参数示例:10",
"title": "Maxresults",
"type": "integer"
},
"NetworkType": {
"default": null,
"description": "安全组的网络类型。取值范围:\n\n- vpc:专有网络。\n- classic:经典网络。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:vpc",
"title": "Networktype",
"type": "string"
},
"NextToken": {
"default": null,
"description": "查询凭证(Token)。取值为上一次调用该接口返回的NextToken参数值,初次调用接口时无需设置该参数。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:e71d8a535bd9cc11",
"title": "Nexttoken",
"type": "string"
},
"PageNumber": {
"default": null,
"description": "> 该参数即将下线,推荐您使用NextToken与MaxResults完成分页查询操作。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: integer,参数示例:1",
"title": "Pagenumber",
"type": "integer"
},
"PageSize": {
"default": null,
"description": "> 该参数即将下线,推荐您使用NextToken与MaxResults完成分页查询操作。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: integer,参数示例:10",
"title": "Pagesize",
"type": "integer"
},
"RegionId": {
"description": "地域ID。您可以调用[DescribeRegions](~~25609~~)查看最新的阿里云地域列表。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:cn-hangzhou",
"title": "Regionid",
"type": "string"
},
"ResourceGroupId": {
"default": null,
"description": "安全组所在的企业资源组ID。使用该参数过滤资源时,资源数量不能超过1000个。您可以调用[ListResourceGroups](~~158855~~)查询资源组列表。\n\n>不支持默认资源组过滤。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:rg-bp67acfmxazb4p****",
"title": "Resourcegroupid",
"type": "string"
},
"SecurityGroupId": {
"default": null,
"description": "安全组ID。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:sg-bp67acfmxazb4p****",
"title": "Securitygroupid",
"type": "string"
},
"SecurityGroupIds": {
"default": null,
"description": "安全组ID列表。一次最多支持100个安全组ID,ID之间用半角逗号(,)隔开,格式为JSON数组。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:[\"sg-bp67acfmxazb4p****\", \"sg-bp67acfmxazb4p****\", \"sg-bp67acfmxazb4p****\",....]",
"title": "Securitygroupids",
"type": "string"
},
"SecurityGroupName": {
"default": null,
"description": "安全组名称。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:SGTestName",
"title": "Securitygroupname",
"type": "string"
},
"SecurityGroupType": {
"default": null,
"description": "安全组类型。取值范围:\n- normal:普通安全组。\n- enterprise:企业安全组。\n\n> 当不为该参数传值时,表示查询所有类型的安全组。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:normal",
"title": "Securitygrouptype",
"type": "string"
},
"ServiceManaged": {
"default": null,
"description": "是否为托管安全组。取值范围:\n\n- true:是托管安全组。\n- false:不是托管安全组。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: boolean,参数示例:false",
"title": "Servicemanaged",
"type": "boolean"
},
"Tag": {
"default": null,
"description": "标签列表。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: array,参数示例:",
"items": {},
"title": "Tag",
"type": "array"
},
"VpcId": {
"default": null,
"description": "安全组所在的专有网络ID。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:vpc-bp67acfmxazb4p****",
"title": "Vpcid",
"type": "string"
}
},
"required": [
"RegionId"
],
"title": "DescribeSecurityGroupsArguments",
"type": "object"
}