DescribeDeploymentSets - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

1 つ以上のデプロイメントセットの詳細を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:DescribeDeploymentSets

get

*DeploymentSet。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	デプロイメントセットのリージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストを照会できます。	cn-hangzhou
PageNumber	integer	任意	デプロイメントセットリストのページ番号。最小値: 1。デフォルト値: 1。	1
PageSize	integer	任意	ページングクエリの 1 ページあたりのエントリ数。最大値: 50。デフォルト値: 10。	10
DeploymentSetIds	string	任意	デプロイメントセットの ID。値は、["ds-xxxxxxxxx", "ds-yyyyyyyyy", … "ds-zzzzzzzzz"] 形式の JSON 配列にできます。最大 100 個の ID がサポートされています。複数の ID はコンマ (,) で区切ります。	["ds-bp67acfmxazb4ph**", "ds-bp67acfmxazb4pi", … "ds-bp67acfmxazb4pj**"]
NetworkType	string	任意	説明このパラメーターは非推奨です。	null
Strategy	string	任意	デプロイメント戦略。有効な値: Availability: 高可用性戦略。 AvailabilityGroup: 高可用性グループ戦略。 LowLatency: 低ネットワーク遅延戦略。	Availability
DeploymentSetName	string	任意	デプロイメントセットの名前。名前は 2～128 文字で、英字、漢字、数字などの Unicode で文字として分類される文字を使用できます。また、コロン (:)、アンダースコア (_)、ピリオド (.)、ハイフン (-) も使用できます。	testDeploymentSetName
Granularity	string	任意	説明このパラメーターは非推奨です。	null
Domain	string	任意	説明このパラメーターは非推奨です。	null
Type	string	任意	デプロイメントタイプ。有効な値: host: 物理マシン sw: vSwitch 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	デプロイメントセットが作成された時間。時間は、協定世界時 (UTC) の ISO 8601 形式で表示されます。	2021-12-07T06:01:46Z
Strategy	string	デプロイメント戦略。	Availability
DeploymentSetId	string	デプロイメントセットの ID。	ds-bp67acfmxazb4ph****
AccountId	integer	Alibaba Cloud アカウント 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

例

成功レスポンス

JSONJSON

{
  "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 ステータスコード	エラーコード	エラーメッセージ	説明
403	InvalidDeploymentSetIds.TooManyInput	The parameter DeploymentSets size should less than 100.	指定されたデプロイメントセットの数が 100 を超えています。

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。