全部產品
Search

搜尋本產品

    Elastic Compute Service：DescribeSecurityGroups

    文件中心

    Elastic Compute Service：DescribeSecurityGroups

    更新時間：Jun 29, 2026

    本介面用於查詢安全性群組基本資訊列表，支援您透過地域、安全性群組ID、安全性群組類型等不同參數查詢。

    介面說明

    • 分頁查詢：推薦您使用MaxResults與NextToken參數進行查詢。

      • 當返回結果中沒有NextToken時，表示該頁為末頁，不再有後續頁。

      • 分頁查詢首頁時，僅需設定MaxResults以限制返回資訊的條目數，返回結果中的NextToken將作為查詢後續頁的憑證。

      • 查詢後續頁時，將NextToken參數設定為上一次返回結果中取得到的NextToken作為查詢憑證，並設定MaxResults限制返回條目數。

    • 透過阿里雲 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
    • ecs:tag
    • ecs:tag
    • 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

    否

    說明

    該參數即將下線，推薦您使用 NextToken 與 MaxResults 完成分頁查詢操作。

    1
    PageSize

    integer

    否

    說明

    該參數即將下線，推薦您使用 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

    object

    SecurityGroup

    array<object>

    安全性群組資訊集合。

    array<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

    integer

    安全性群組對應的虛商 ID。

    12345678910
    Tags

    object

    Tag

    array<object>

    安全性群組的標籤集合。

    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.
    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.

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。