NAS：DescribeNASSecurityGroups
処理概要
NASファイアウォールグループの情報を取得します。
NASSecurityGroupName（NASファイアウォールグループ名）が指定された場合は該当するNASファイアウォールグループの情報のみが返却されます。
リクエストパラメーター
| 要素名 | 説明 | 必須 | 値 | 最大値 | デフォルト値 | 備考 |
|---|---|---|---|---|---|---|
| NASSecurityGroupName | NASファイアウォールグループ名 | ○ | 文字列 | − | − |
レスポンス
XML
status
statusは共通の応答メッセージを返却します。
result
| 要素名 | 説明 | 値 | 備考 |
|---|---|---|---|
| DescribeNASSecurityGroupsResponse | ルート | − | |
| DescribeNASSecurityGroupsResult | 結果 | − | |
| NASSecurityGroups | NASファイアウォールグループリスト | − | |
| NASSecurityGroup | NASファイアウォールグループ | − | |
| NASSecurityGroupDescription | NASファイアウォールグループの説明 | 文字列 | |
| NASSecurityGroupName | NASファイアウォールグループ名 | 文字列 | |
| SecurityGroups | ニフクラファイアウォールグループ要素リスト | リスト | |
| SecurityGroup | ニフクラファイアウォールグループ要素 | − | |
| SecurityGroupName | ニフクラファイアウォールグループ名 | 文字列 | |
| SecurityGroupOwnerId | ニフクラのファイアウォールグループを所有している ニフクラID | 文字列 | |
| Status | ニフクラのファイアウォールグループのステータス 値：authorized(有効)|authorizing(追加中)|revoking(削除中)|auth-failed(追加エラー)|revoke-failed(削除エラー)|not-exists(追加エラー(グループが存在しません)) |
文字列 | |
| IPRanges | IP帯リスト | リスト | |
| IPRange | IP帯 | − | |
| CIDRIP | CIDR | 文字列 | |
| Status | IP帯のステータス 値：authorized(有効)|authorizing(追加中)|revoking(削除中)|auth-failed(追加エラー)|revoke-failed(削除エラー)) |
文字列 | |
| OwnerId | NASファイアウォールグループを所有している ニフクラID | 文字列 | |
| AvailabilityZone | NASファイアウォールグループのゾーン | 文字列 | |
| ResponseMetadata | 共通メタ情報 | − |
エラー
| コード | メッセージ | タイプ | HTTPステータスコード | 説明 |
|---|---|---|---|---|
| Client.InvalidParameter.NotFound.NASSecurityGroupName | NASSecurityGroup aaaa not found. | Sender | 404 | NASSecurityGroupNameに存在しないファイアウォールグループ名を指定した場合 |
| Client.InvalidParameter.NotAllowed.NASSecurityGroupName | NASSecurityGroupName can contain only ASCII letters and digits, spaces, underscores, and hyphens | Sender | 400 | NASSecurityGroupNameに無効な文字（全角文字など）を指定した場合 |
| Client.InvalidParameter.TooLong.NASSecurityGroupName | NASSecurityGroupName can be no longer than 255 characters | Sender | 400 | NASSecurityGroupNameに255文字以上指定した場合 |
リクエストサンプル
https://jp-east-1.nas.api.nifcloud.com/
?Action=DescribeNASSecurityGroups
&NASSecurityGroupName=exsample-securitygroup
&SignatureVersion=2
&SignatureMethod=HmacSHA256
&Timestamp=2016-02-24T00%3A00%3A00.000Z
&AWSAccessKeyId=<Nifty Cloud Access Key ID>
&Signature=<Signature>
レスポンスサンプル
<DescribeNASSecurityGroupsResponse>
<DescribeNASSecurityGroupsResult>
<NASSecurityGroups>
<NASSecurityGroup>
<NASSecurityGroupName>exsample-securitygroup</NASSecurityGroupName>
<SecurityGroups/>
<IPRanges>
<IPRange>
<CIDRIP>xxx.xxx.xxx.xxx/xx</CIDRIP>
<Status>authorized</Status>
</IPRange>
</IPRanges>
<OwnerId>ABC01234</OwnerId>
<AvailabilityZone>east-21</AvailabilityZone>
</NASSecurityGroup>
</NASSecurityGroups>
</DescribeNASSecurityGroupsResult>
<ResponseMetadata>
<RequestId>408ad14c-8c7c-4187-981f-6603024aff45</RequestId>
</ResponseMetadata>
</DescribeNASSecurityGroupsResponse>
