専有エンドポイント：DescribeDEPSecurityGroups
処理概要
専有エンドポイントFWグループの情報を取得します。
DEPSecurityGroupName（専有エンドポイントFWグループ名）が指定された場合は該当する専有エンドポイントFWグループの情報のみが返却されます。
リクエストパラメーター
| 要素名 | 説明 | 必須 | 値 | 最大値 | デフォルト値 | 備考 |
|---|---|---|---|---|---|---|
| DEPSecurityGroupName | 専有エンドポイントFWグループ名
|
文字列 | - | - |
レスポンス
XML
status
statusは共通の応答メッセージを返却します。
result
| 要素名 | 説明 | 値 | 備考 |
|---|---|---|---|
| DescribeDEPSecurityGroupsResponse | ルート | − | |
| DescribeDEPSecurityGroupsResult | 結果 | − | |
| DEPSecurityGroups | 専有エンドポイントFWグループ情報リスト | リスト | |
| DEPSecurityGroup | 専有エンドポイントFWグループ | − | |
| DEPSecurityGroupDescription | 専有エンドポイントFWグループの説明 | 文字列 | |
| DEPSecurityGroupName | 専有エンドポイントFWグループ名 | 文字列 | |
| SecurityGroups | ニフクラファイアウォールグループ要素リスト | リスト | |
| SecurityGroup | ニフクラファイアウォールグループ要素 | - | |
| SecurityGroupName | ニフクラファイアウォールグループ名 | 文字列 | |
| SecurityGroupOwnerId | ニフクラファイアウォールグループを所有するニフクラID | 文字列 | |
| Status | ニフクラファイアウォールグループのステータス | 文字列 | |
| IPRanges | IP帯リスト | リスト | |
| IPRange | IP帯 | - | |
| CIDRIP | IP帯 | 文字列 | |
| Status | IP帯のステータス | 文字列 | |
| OwnerId | 専有エンドポイントFWグループを所有するニフクラID | 文字列 | |
| AvailabilityZone | 専有エンドポイントFWグループのゾーン | 文字列 | |
| ResponseMetadata | 共通メタ | - |
エラー
| コード | メッセージ | タイプ | HTTPステータスコード | 説明 |
|---|---|---|---|---|
| Client.InvalidParameterCannotSpecify.DEPSecurityGroupName | DEPSecurityGroupName must not contain leading or trailing spaces. | Sender | 400 | DEPSecurityGroupNameの最初か最後に " " を入力した場合 |
| Client.InvalidParameterFormat.DEPSecurityGroupName | DEPSecurityGroupName can contain only ASCII letters and digits, spaces, underscores, and hyphens. | Sender | 400 | DEPSecurityGroupNameに無効な値(@、全角文字等)を指定した場合 |
| Client.InvalidParameterNotFound.DEPSecurityGroup | DEPSecurityGroup aaaa not found. | Sender | 404 | DEPSecurityGroupNameに存在しないファイアウォールグループ名を指定した場合 |
| Client.InvalidParameterTooLong.DEPSecurityGroupName | DEPSecurityGroupName can be no longer than 255 characters. | Sender | 400 | DEPSecurityGroupNameに255文字を超える値を入力した場合 |
リクエストサンプル
https://jp-east-1.dep.api.nifcloud.com/
?Action=DescribeDEPSecurityGroups
&DEPSecurityGroupName=exsample-securitygroup
&SignatureVersion=2
&SignatureMethod=HmacSHA256
&Timestamp=2017-11-15T00%3A00%3A00.000Z
&AWSAccessKeyId=<Nifty Cloud Access Key ID>
&Signature=<Signature>
レスポンスサンプル
<DescribeDEPSecurityGroupsResponse>
<DescribeDEPSecurityGroupsResult>
<DEPSecurityGroups>
<DEPSecurityGroup>
<DEPSecurityGroupName>exsample-securitygroup</DEPSecurityGroupName>
<SecurityGroups/>
<IPRanges>
<IPRange>
<CIDRIP>192.168.2.101/32</CIDRIP>
<Status>authorized</Status>
</IPRange>
</IPRanges>
<OwnerId>ZYP11117</OwnerId>
<AvailabilityZone>east-13</AvailabilityZone>
</DEPSecurityGroup>
</DEPSecurityGroups>
</DescribeDEPSecurityGroupsResult>
<ResponseMetadata>
<RequestId>62f48a0f-6dd8-4e44-92f0-f00a58093721</RequestId>
</ResponseMetadata>
</DescribeDEPSecurityGroupsResponse>
