全部產品
Search
文件中心

Security Center:DescribeGroupedInstances

更新時間:Jun 16, 2026

按照指定的聚合維度去查詢資產的統計資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-sas:DescribeGroupedInstances

get

*全部资源

*

請求參數

名稱

類型

必填

描述

樣本值

Lang

string

設定請求和接收訊息的語言類型,預設值為 zh。取值:

  • zh:中文

  • en:英文。

zh

MachineTypes

string

要查詢的資產的類型。固定取值:ecs,表示雲端伺服器。

ecs

GroupField

string

查詢資產的過濾條件。取值:

  • groupId:表示按照資產的分組查詢。

  • regionId:表示按照資產所在的地域查詢。

  • vpcInstanceId:表示按照資產所屬的專有網路 VPC 查詢。

groupId

FieldValue

string

要查詢的資產分組的名稱,支援模糊搜尋。

test-01

NoPage

boolean

設定是否啟用分頁查詢。預設值為 true。取值:

  • true:啟用分頁查詢。

  • false:不啟用分頁查詢。

true

PageSize

integer

設定分頁查詢時,每頁顯示的資產資訊的數量。 預設值為 20,表示每頁顯示 20 條資產資訊。

20

CurrentPage

integer

設定從返回結果的第幾頁開始顯示查詢結果。預設值為 1,表示從第 1 頁開始顯示。

1

Vendor

integer

伺服器廠商。取值:

  • 0:阿里雲資產

  • 1:雲外資產

  • 2:IDC 資產

  • 3457:其它雲端資產

  • 8:輕量級資產。

0

Vendors

string

伺服器廠商。多個廠商使用半形逗號(,)分隔。取值:

  • 0:阿里雲資產

  • 1:雲外資產

  • 2:IDC 資產

  • 3457:其它雲端資產

  • 8:輕量級資產。

0,8

SaleVersionCheckCode

string

查詢資產的售賣條件過濾。取值:

  • sas_gte_advanced:大於等於高級版

  • sas_gte_enterprise:大於等於企業版

  • sas_gt_basic:付費版

  • sas_eq_advanced:等於高級版

  • sas_gt_anti_virus:大於防病毒版。

sas_gt_basic

返回參數

名稱

類型

描述

樣本值

object

請求返回資料。

RequestId

string

本次呼叫請求的 ID,是由阿里雲為該請求生成的唯一識別碼,可用於排查和定位問題。

52A3AEE6-114A-499D-8990-4BA9B27FE0AA

PageInfo

object

查詢結果的分頁資訊。

CurrentPage

integer

分頁查詢時,當前頁的頁碼。

5

PageSize

integer

分頁查詢時,每頁顯示的資產資訊的數量。 預設值為 20,表示每頁顯示 20 條資產資訊。

20

TotalCount

integer

查詢到的資產資訊的總數量。

100

Count

integer

分頁查詢時,當前頁面顯示的資產的數量。

20

Instances

array<object>

查詢到的資產資訊的列表。

object

查詢到的資產資訊。

AsapVulInstanceCount

integer

存在高危漏洞的資產的數量。

11

UnProtectedInstanceCount

string

未受到雲端安全中心防護的資產的數量。

32

FieldAliasName

string

伺服器分組的名稱。

testA

InstanceCount

string

查詢時指定的資產類型下所有資產的數量。

說明

如果未設定請求參數 MachineTypes,則該參數返回值為您所有類型的資產的總數量。

205

RiskInstanceCount

string

存在安全風險的資產數量。

172

GroupFlag

integer

伺服器分組類型。取值:

  • 0:預設分組

  • 1:其他分組。

1

AuthVersionCheckCount

integer

符合售賣條件的資產數量。

205

Os

string

資產系統類型。取值:

  • windows

  • linux
    重要 該欄位僅在 Langzh 時返回。

windows

InstanceCoreCount

integer

查詢時指定的資產類型下所有資產的計算核數。

說明

如果未設定請求參數 MachineTypes,則該參數返回值為您所有類型的資產的計算核數。

610

樣本

正常返回樣本

JSON格式

{
  "RequestId": "52A3AEE6-114A-499D-8990-4BA9B27FE0AA",
  "PageInfo": {
    "CurrentPage": 5,
    "PageSize": 20,
    "TotalCount": 100,
    "Count": 20
  },
  "Instances": [
    {
      "AsapVulInstanceCount": 11,
      "UnProtectedInstanceCount": "32",
      "FieldAliasName": "testA",
      "InstanceCount": "205",
      "RiskInstanceCount": "172",
      "GroupFlag": 1,
      "AuthVersionCheckCount": 205,
      "Os": "windows",
      "InstanceCoreCount": 610
    }
  ]
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 NoPermission no permission
500 ServerError ServerError
403 NoPermission caller has no permission

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

變更歷史

更多資訊,參考變更詳情