ニフクラAPI (NAS: DescribeNASSecurityGroups)

DescribeNASSecurityGroups

処理概要

NASファイアウォールグループの情報を取得します。
NASSecurityGroupName（NASファイアウォールグループ名）が指定された場合は該当するNASファイアウォールグループの情報のみが返却されます。

指定するパラメーター

パラメーター	型	説明	必須
NASSecurityGroupName	string	NASファイアウォールグループ名

応答フィールド

フィールド (項目)	型	説明
DescribeNASSecurityGroupsResponse	structure	ルート
␣DescribeNASSecurityGroupsResult	structure	結果
␣␣NASSecurityGroups	list	NASファイアウォールグループリスト
␣␣␣NASSecurityGroup	structure	NASファイアウォールグループ 備考: NASSecurityGroupの子要素はDescribeNASSecurityGroupsで返却される要素をすべて記載しているためAPIによっては返却されない要素もあります。実際のレスポンスはレスポンスサンプルを参照してください。
␣␣␣␣NASSecurityGroupDescription	string	NASファイアウォールグループの説明
␣␣␣␣NASSecurityGroupName	string	NASファイアウォールグループ名
␣␣␣␣SecurityGroups	list	ニフクラファイアウォールグループ要素リスト
␣␣␣␣␣SecurityGroup	structure	ニフクラファイアウォールグループ要素
␣␣␣␣␣␣SecurityGroupName	string	ニフクラファイアウォールグループ名
␣␣␣␣␣␣SecurityGroupOwnerId	string	ニフクラのファイアウォールグループを所有している ニフクラID
␣␣␣␣␣␣Status	string	ニフクラのファイアウォールグループのステータス 値：authorized(有効)|authorizing(追加中)|revoking(削除中)|auth-failed(追加エラー)|revoke-failed(削除エラー)|not-exists(追加エラー(グループが存在しません))
␣␣␣␣IPRanges	list	IP帯リスト
␣␣␣␣␣IPRange	structure	IP帯
␣␣␣␣␣␣CIDRIP	string	CIDR
␣␣␣␣␣␣Status	string	IP帯のステータス 値：authorized(有効)|authorizing(追加中)|revoking(削除中)|auth-failed(追加エラー)|revoke-failed(削除エラー))
␣␣␣␣OwnerId	string	NASファイアウォールグループを所有している ニフクラID
␣␣␣␣AvailabilityZone	string	NASファイアウォールグループのゾーン
␣ResponseMetadata	structure	共通メタ情報
␣␣RequestId	string	リクエスト識別子

エラー

コード	メッセージ	タイプ	HTTPステータスコード	説明
Client.InvalidParameter.NotFound.NASSecurityGroupName	NASSecurityGroup aaaa not found.	Sender	404	NASSecurityGroupNameに存在しないファイアウォールグループ名を指定した場合
Client.InvalidParameter.NotAllowed.NASSecurityGroupName	NASSecurityGroupName can contain only lowercase 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:00:00.000Z
  &AWSAccessKeyId=<NIFCLOUD 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>