本接口用于查詢安全組基本信息列表，支持您通過地域、安全組ID、安全組類型等不同參數(shù)查詢。
接口說明
- 分頁查詢：推薦您使用
MaxResults與NextToken參數(shù)進行查詢。- 當(dāng)返回結(jié)果中沒有
NextToken時，表示該頁為末頁，不再有后續(xù)頁。 - 分頁查詢首頁時，僅需設(shè)置
MaxResults以限制返回信息的條目數(shù)，返回結(jié)果中的NextToken將作為查詢后續(xù)頁的憑證。 - 查詢后續(xù)頁時，將
NextToken參數(shù)設(shè)置為上一次返回結(jié)果中獲取到的NextToken作為查詢憑證，并設(shè)置MaxResults限制返回條目數(shù)。
- 當(dāng)返回結(jié)果中沒有
- 通過阿里云 CLI 調(diào)用 API 時，不同數(shù)據(jù)類型的請求參數(shù)取值必須遵循一定的格式要求。更多信息，請參見 CLI 參數(shù)格式說明。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| ecs:DescribeSecurityGroups | get | *SecurityGroup acs:ecs:{#regionId}:{#accountId}:securitygroup/**SecurityGroup acs:ecs:{#regionId}:{#accountId}:securitygroup/{#securitygroupId} |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| SecurityGroupIds | string | 否 | 安全組 ID 列表。一次最多支持 100 個安全組 ID，ID 之間用半角逗號（,）隔開，格式為 JSON 數(shù)組。 | ["sg-bp67acfmxazb4p****", "sg-bp67acfmxazb4p****", "sg-bp67acfmxazb4p****",....] |
| VpcId | string | 否 | 安全組所在的專有網(wǎng)絡(luò) ID。 | vpc-bp67acfmxazb4p**** |
| SecurityGroupType | string | 否 | 安全組類型。取值范圍：
說明
當(dāng)不為該參數(shù)傳值時，表示查詢所有類型的安全組。
| normal |
| NextToken | string | 否 | 查詢憑證（Token）。取值為上一次調(diào)用該接口返回的 NextToken 參數(shù)值，初次調(diào)用接口時無需設(shè)置該參數(shù)。 | e71d8a535bd9cc11 |
| MaxResults | integer | 否 | 分頁查詢時每頁的最大條目數(shù)。一旦設(shè)置該參數(shù)，即表示使用 最大值為 100。 默認(rèn)值為 10。 | 10 |
| NetworkType | string | 否 | 安全組的網(wǎng)絡(luò)類型。取值范圍：
| vpc |
| SecurityGroupName | string | 否 | 安全組名稱。 | SGTestName |
| IsQueryEcsCount | boolean | 否 | 是否查詢安全組的容量信息。傳 True 時，返回值中的 說明
該參數(shù)已廢棄。
| null |
| ResourceGroupId | string | 否 | 安全組所在的企業(yè)資源組 ID。使用該參數(shù)過濾資源時，資源數(shù)量不能超過 1000 個。您可以調(diào)用 ListResourceGroups 查詢資源組列表。 說明
不支持默認(rèn)資源組過濾。
| rg-bp67acfmxazb4p**** |
| Tag | array<object> | 否 | 標(biāo)簽列表。 | |
| object | 否 | 標(biāo)簽列表。 | ||
| key | string | 否 | 安全組的標(biāo)簽鍵。 說明
為提高兼容性，建議您盡量使用 Tag.N.Key 參數(shù)。
| testkey |
| Key | string | 否 | 安全組的標(biāo)簽鍵。N 的取值范圍為 1~20。 使用一個標(biāo)簽過濾資源，查詢到該標(biāo)簽下的資源數(shù)量不能超過 1000 個；使用多個標(biāo)簽過濾資源，查詢到同時綁定了多個標(biāo)簽的資源數(shù)量不能超過 1000 個。如果資源數(shù)量超過 1000 個，請使用 ListTagResources 接口進行查詢。 | TestKey |
| Value | string | 否 | 安全組的標(biāo)簽值。N 的取值范圍：1~20。 | TestValue |
| value | string | 否 | 安全組的標(biāo)簽值。 說明
為提高兼容性，建議您盡量使用 Tag.N.Value 參數(shù)。
| testvalue |
| DryRun | boolean | 否 | 是否只預(yù)檢此次請求。取值范圍：
默認(rèn)值為 false。 | false |
| SecurityGroupId | string | 否 | 安全組 ID。 | sg-bp67acfmxazb4p**** |
| FuzzyQuery | boolean | 否 | 說明
該參數(shù)已廢棄。
| null |
| PageNumber | integer | 否 | 說明
該參數(shù)即將下線，推薦您使用 NextToken 與 MaxResults 完成分頁查詢操作。
| 1 |
| PageSize | integer | 否 | 說明
該參數(shù)即將下線，推薦您使用 NextToken 與 MaxResults 完成分頁查詢操作。
| 10 |
| ServiceManaged | boolean | 否 | 是否為托管安全組。取值范圍：
| false |
返回參數(shù)
示例
正常返回示例
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. | 參數(shù)PageNumber和PageSize已經(jīng)不受支持，請使用參數(shù)NextToken和MaxResults。 |
| 400 | InValidParameter.NextToken | The parameter NextToken is invalid. | 指定的參數(shù)NextToken不合法。 |
| 400 | MissingParameter.RegionId | The input parameter RegionId that is mandatory for processing this request is not supplied. | 參數(shù) RegionId 不能為空。 |
| 400 | InvalidParameter.SecurityGroupType | The specified SecurityGroupType is not valid. | 指定的 SecurityGroupType 參數(shù)無效，請檢查該參數(shù)取值是否正確。 |
| 400 | InvalidSecurityGroupId.Malformed | The specified parameter SecurityGroupId is not valid. | 指定的參數(shù) SecurityGroupId 無效。 |
| 400 | InvalidSecurityGroupName.Malformed | The specified parameter SecurityGroupName is not valid. | 指定的安全組名稱格式不合法。請您按照規(guī)則進行配置：默認(rèn)值為空，長度為 2-128 個英文或中文字符，必須以大小字母或中文開頭，可包含數(shù)字，英文句號（.），下劃線（_）或連字符（-），安全組名稱會展示在控制臺。不能以 http:// 和 https:// 開頭。 |
| 500 | InternalError | The request processing has failed due to some unknown error. | 內(nèi)部錯誤，請重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-09-23 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2023-11-14 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2023-04-07 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2021-12-05 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2021-10-12 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |