DescribeDeploymentSets - 查詢部署集的屬性 - Elastic Compute Service

查詢一個或多個部署集的詳細資料。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:DescribeDeploymentSets

get

*DeploymentSet

acs:ecs:{#regionId}:{#accountId}:deploymentset/*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	部署集所屬地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。	cn-hangzhou
PageNumber	integer	否	部署集列表的頁碼。起始值為 1。預設值為 1。	1
PageSize	integer	否	分頁查詢時設定的每頁行數。最大值為 50。預設值為 10。	10
DeploymentSetIds	string	否	部署集 ID 列表。取值可以由多個部署集 ID 組成一個 JSON 數組，格式為`["ds-xxxxxxxxx", "ds-yyyyyyyyy", … "ds-zzzzzzzzz"]`。最多支援 100 個 ID，ID 之間用半形逗號（,）隔開。	["ds-bp67acfmxazb4ph**", "ds-bp67acfmxazb4pi", … "ds-bp67acfmxazb4pj**"]
NetworkType	string	否	說明該參數已廢棄。	null
Strategy	string	否	部署策略。取值範圍： Availability：高可用策略。 AvailabilityGroup：部署集組高可用策略。 LowLatency：網路低時延策略。	Availability
DeploymentSetName	string	否	部署集名稱。長度為 2~128 個字元，支援 Unicode 中 letter 分類下的字元（其中包括英文、中文和數字等）。可以包含半形冒號（:）、底線（_）、半形句號（.）或者短劃線（-）。	testDeploymentSetName
Granularity	string	否	說明該參數已廢棄。	null
Domain	string	否	說明該參數已廢棄。	null
Type	string	否	部署類型。取值範圍： host：物理機 sw：交換器 rack：機架預設值：host。	host

返回參數

名稱	類型	描述	樣本值
	object
PageSize	integer	設定的每頁行數。	1
PageNumber	integer	部署集列表的頁數。	1
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	查詢到的部署集總數。	5
RegionId	string	部署集所處的地區 ID。	cn-hangzhou
DeploymentSets	object
DeploymentSet	array<object>	由 DeploymentSet 組成的數組格式，返回部署集詳細資料。
	array<object>
CreationTime	string	部署集的建立時間。	2021-12-07T06:01:46Z
Strategy	string	部署策略。	Availability
DeploymentSetId	string	部署集 ID。	ds-bp67acfmxazb4ph****
AccountId	integer	阿里雲帳號 ID。	1732*******734
DeploymentStrategy	string	部署策略。該傳回值對應請求參數`Strategy`的值。	Availability
DeploymentSetDescription	string	部署集的描述資訊。	testDeploymentSetDescription
Domain	string	部署域。	default
GroupCount	integer	部署集中的分組數量。說明當部署集策略為部署集組高可用策略（AvailabilityGroup）時，該傳回值生效。	3
Granularity	string	部署粒度。	host
DeploymentSetName	string	部署集名稱。	testDeploymentSetName
InstanceAmount	integer	部署集內的執行個體數量。	3
InstanceIds	object
InstanceId	array	部署集內的執行個體 ID 列表。
	string	執行個體 ID。	i-bp67acfmxazb4ph****
Capacities	object
Capacity	array<object>	由 Capacity 組成的數組格式。僅當部署集內有存量 ECS 執行個體時提供返回結果，返回結果包含部署集可用性區域維度容量資訊。
	object
ZoneId	string	可用性區域 ID。只返回部署集記憶體量 ECS 執行個體所屬的可用性區域 ID。	cn-hangzhou-i
UsedAmount	integer	部署集內屬於該可用性區域的 ECS 執行個體數量。	2
AvailableAmount	integer	該可用性區域內，還可以加入當前部署集的 ECS 執行個體數量。	18
Type	string	部署類型。	host
Affinity	integer	部署集的親和度層級。	3

樣本

正常返回樣本

JSON格式

{
  "PageSize": 1,
  "PageNumber": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 5,
  "RegionId": "cn-hangzhou",
  "DeploymentSets": {
    "DeploymentSet": [
      {
        "CreationTime": "2021-12-07T06:01:46Z",
        "Strategy": "Availability",
        "DeploymentSetId": "ds-bp67acfmxazb4ph****",
        "AccountId": 0,
        "DeploymentStrategy": "Availability",
        "DeploymentSetDescription": "testDeploymentSetDescription",
        "Domain": "default",
        "GroupCount": 3,
        "Granularity": "host",
        "DeploymentSetName": "testDeploymentSetName",
        "InstanceAmount": 3,
        "InstanceIds": {
          "InstanceId": [
            "i-bp67acfmxazb4ph****"
          ]
        },
        "Capacities": {
          "Capacity": [
            {
              "ZoneId": "cn-hangzhou-i",
              "UsedAmount": 2,
              "AvailableAmount": 18
            }
          ]
        },
        "Type": "host",
        "Affinity": 3
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
403	InvalidDeploymentSetIds.TooManyInput	The parameter DeploymentSets size should less than 100.	指定的 DeploymentSets 數量大於 100。

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

變更歷史

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