1 つやそれ以上のデプロイメントセットの属性の一覧を照会します。
デバッグ
API Explorer を使用してデバッグを実行できます。 API Explorer を使用することで、さまざまな操作を実行して API の使用を簡単にできます。 たとえば、API の取得、API の呼び出し、SDK のサンプルコードの動的な生成ができます。
リクエストパラメータ
| 名前 | 型 | 必須 / 省略可能 | 例 | 説明 |
|---|---|---|---|---|
| RegionId | 文字列 | 必須 | cn-hangzhou |
デプロイメントセットが存在するリージョンの ID。 DescribeRegions を呼び出して、Alibaba Cloud リージョンの最新リストを表示できます。 |
| Action | String | いいえ | DescribeDeploymentSets |
実行する操作. 値を DescribeDeploymentSets に設定します。 |
| DeploymentSetIds | String | いいえ | ["ds-xxxxxxxxx", "ds-yyyyyyyyy", … "ds-zzzzzzzzz"] |
デプロイメントセット ID のリスト。 値には、最大 100 個のデプロイメントセット ID で構成される JSON 配列を含めることができます。 デプロイメントセット ID は、コンマ(、)で区切る必要があります。 |
| DeploymentSetName | String | いいえ | FinanceJoshua |
デプロイメントセットの名前。 |
| Domain | String | いいえ | デフォルト |
デプロイメントドメイン。 注 このパラメータは将来削除される予定です。 互換性を確保するために他のパラメータを使用することを推奨します。
|
| Granularity | String | いいえ | Host |
デプロイメントの細分性。 注 このパラメーターは将来削除される予定です。 互換性を確保するために他のパラメータを使用することを推奨します。
|
| NetworkType | String | いいえ | VPC |
デプロイメントセット内のネットワークの種類。 注 このパラメータは将来削除される予定です。 互換性を確保するために他のパラメータを使用することを推奨します。
|
| PageNumber | Integer | いいえ | 1 |
デプロイメントセットリストで照会されるページ番号。 開始値:1。 デフォルト値 : 1。 |
| PageSize | Integer | いいえ | 10 |
1 ページあたりのエントリー数。 最大値:100。 デフォルト値: 10。 |
| Strategy | String | いいえ | Availability |
デプロイメント方針。 値:Availability。 デフォルト値 : NULL。 |
レスポンスパラメータ
| 名前 | 型 | 例 | 説明 |
|---|---|---|---|
| DeploymentSets |
デプロイメントセットの詳細情報が配列として返されます。 |
||
| └CreationTime | String | 2017-12-05T22:40:00Z |
デプロイメントセットが作成された時刻。 |
| └DeploymentSetDescription | String | FinanceDeptHighAvailability |
デプロイメントセットの説明。 |
| └DeploymentSetId | String | ds-deploymentsetid1 |
デプロイメントセットの ID。 |
| └DeploymentSetName | String | FinanceJoshua |
デプロイメントセットの名前。 |
| └DeploymentStrategy | String | Availability |
デプロイメント方針。 |
| └Domain | String | デフォルト |
デプロイメントドメイン |
| └Granularity | String | Host |
デプロイメントの細分性 |
| └InstanceAmount | Integer | 1 |
デプロイメントセット内のインスタンス数。 |
| └InstanceIds | ["i-instanceid1"] |
デプロイメントセット内のインスタンス ID のリスト。 |
|
| └Strategy | String | StrictDispersion |
デプロイメント方針。 |
| PageNumber | Integer | 1 |
デプロイメントセットリストで照会されるページ番号。 |
| PageSize | Integer | 10 |
1 ページあたりのエントリー数。 |
| RegionId | String | cn-hangzhou |
デプロイメントセットが存在するリージョンの ID。 |
| RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
リクエストの ID。 |
| TotalCount | Integer | 1 |
照会されたデプロイメントセットの総数。 |
例
リクエストのコーディング例
https://ecs.aliyuncs.com/?Action=DescribeDeploymentSets
&RegionId=cn-hangzhou
&DeploymentSetsIds=["ds-bp13v7bjnj9gisnlo1"]
&<Common request parameters>
成功したレスポンスのコーディング例
XML 形式
<DescribeDeploymentSetsResponse>
<PageSize>10</PageSize>
<TotalCount>1</TotalCount>
<PageNumber>1</PageNumber>
<RequestId>1CB9A584-9E43-408D-B5A8-DB42CDECE03B</RequestId>
<DeploymentSets>
<DeploymentSet>
<DeploymentSetDescription>default</DeploymentSetDescription>
<DeploymentSetId>ds-bp13v7bjnj9gisnlo1ow</DeploymentSetId>
<DeploymentStrategy>Availability</DeploymentStrategy>
<DeploymentSetName>test default</DeploymentSetName>
<InstanceIds>
<InstanceId>i-sdfkjsdfk</InstanceId>
<InstanceId>i-kiiwsch</InstanceId>
</InstanceIds>
</DeploymentSet>
</DeploymentSets>
</DescribeDeploymentSetsResponse>
JSON 形式
{
"DeploymentSets":{
"DeploymentSet":[
{
"DeploymentSetDescription":"default",
"InstanceIds":{
"InstanceId":[
"i-sdfkjsdfk",
"i-kiiwsch"
]
},
"DeploymentSetName":"test default",
"DeploymentStrategy":"Availability",
"DeploymentSetId":"ds-bp13v7bjnj9gisnlo1ow"
}
]
},
"PageNumber":1,
"TotalCount":1,
"PageSize":10,
"RequestId":"1CB9A584-9E43-408D-B5A8-DB42CDECE03B"
}
エラーコード
| HTTP ステータスコード | エラーコード | エラーメッセージ | 説明 |
|---|---|---|---|
| 403 | InvalidDeploymentSetIds.TooManyInput | パラメータ DeploymentSets のサイズは 100 未満にする必要があります。 | 指定されたデプロイメントセットの数が 100 を超えると返されるエラーメッセージ。 |