全部產品
Search

搜尋本產品

    Elastic Compute Service：DescribeResourceByTags - 根據標籤檢索資源

    文件中心

    Elastic Compute Service：DescribeResourceByTags - 根據標籤檢索資源

    更新時間：Apr 21, 2026

    調用DescribeResourceByTags根據標籤檢索資源。支援根據標籤檢索，也支援根據資源類型檢索。

    說明

    目前該API介面已標記為棄用，推薦使用替代API：Tag(2018-08-28) - ListResourcesByTag。

    調試

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

    調試

    授權資訊

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

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

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    ecs:DescribeResourceByTags

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    PageSize

    integer

    否

    查詢結果顯示的每頁的資訊條目數。最大值：100。

    預設值：50。

    50
    PageNumber

    integer

    否

    查詢結果顯示的頁碼。起始值：1。

    預設值：1。

    1
    ResourceType

    string

    否

    資源類型。取值範圍：

    • instance：ECS 執行個體。

    • disk：磁碟。

    • snapshot：快照。

    • image：鏡像。

    • securitygroup：安全性群組。

    • volume：儲存卷。

    • eni：彈性網卡。

    • ddh：Dedicated Host。

    • keypair：SSH 金鑰對。

    • launchtemplate：啟動模板。

    以上取值均為小寫。

    instance
    RegionId

    string

    是

    資源所屬的地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。

    cn-hangzhou
    Tag

    array<object>

    否

    標籤列表。

    object

    否

    標籤列表。

    key

    string

    否

    資源的標籤鍵。

    說明

    為提高相容性，建議您盡量使用 Tag.N.Key 參數。

    testkey
    Key

    string

    否

    資源的標籤鍵。N 的取值範圍：1~20。一旦傳入該值，則不允許為空白字串。最多支援 128 個字元。

    TestKey
    Value

    string

    否

    資源的標籤值。N 的取值範圍：1~20。一旦傳入該值，允許為空白字串。最多支援 128 個字元。

    TestValue
    value

    string

    否

    資源的標籤值。

    說明

    為提高相容性，建議您盡量使用 Tag.N.Value 參數。

    testvalue

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    1C1E5359-71D7-44D8-8FAA-0327B549157X
    PageSize

    integer

    查詢結果顯示的每頁的資訊條目數。

    50
    PageNumber

    integer

    查詢結果顯示的頁碼。

    1
    TotalCount

    integer

    返回的資源總數。

    8
    Resources

    object

    Resource

    array<object>

    綁定標籤的資源資訊集合。

    object

    ResourceType

    string

    資源類型。

    instance
    ResourceId

    string

    資源 ID。

    i-bp16t2cgmiiy7t1c****
    RegionId

    string

    地區 ID。

    cn-hangzhou

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "1C1E5359-71D7-44D8-8FAA-0327B549157X",
  "PageSize": 50,
  "PageNumber": 1,
  "TotalCount": 8,
  "Resources": {
    "Resource": [
      {
        "ResourceType": "instance",
        "ResourceId": "i-bp16t2cgmiiy7t1c****",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidTagCount The specified tags are beyond the permitted range. 指定的標記超出取值範圍。
    404 InvalidRegionId.NotFound The specified RegionId does not exist. 指定的地區 ID 不存在。
    404 InvalidResourceType.NotFound The ResourceType provided does not exist in our records. 指定的資源類型不存在。

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

    變更歷史

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