DescribeSecurityGroups を呼び出して、セキュリティグループに関する基本情報 (セキュリティグループ ID、説明等) を照会することができます。 セキュリティグループは、セキュリティグループ ID の降順で表示されます。

デバッグ

API を簡単に使用できるようにするため、Alibaba Cloud は OpenAPI Explorer を提供しています。 OpenAPI Explorer を使用して、API の検索、API の呼び出し、SDK サンプルコードの動的生成を行うことができます。

リクエストパラメーター

パラメーター タイプ 必須 例 説明
RegionId String Yes cn-hangzhou

セキュリティグループのリージョン ID。 DescribeRegions を呼び出すと、最新のリージョンリストが表示されます。

Action String No DescribeSecurityGroups

実行する操作です。 この値を DescribeSecurityGroups に設定します。
DryRun Boolean No false

チェックリクエストのみを送信するかを指定します。 規定値：false

  • true：チェックリクエストのみが送信され、クエリは実行されません。 システムが AccessKey の有効性、RAM ユーザーの権限の有無、必要なパラメーターの設定有無を確認します。 チェックが失敗した場合、対応するエラーコードが返されます。 チェックが成功した場合、DryRunOperation と返されます。
  • false：リクエストを送信します。 2XX HTTP ステータスコードが返された場合はクエリが実行されます。

規定値：false
NetworkType String No vpc

ネットワークタイプ。
PageNumber Integer No 1

返されるページ数。 ページは1ページ目から始まります。

規定値：1

PageSize Integer No 10

返される各ページのエントリ数。 最大値：50

既定値：1

ResourceGroupId String No rg-resourcegroupid1

リソースグループが属するリソースグループの ID 。
SecurityGroupId String No sg-securitygroupid

セキュリティグループの ID。
SecurityGroupIds String No ["sg-id1"、 "sg-id2"、 "sg-id2"、...]

セキュリティグループ ID の JSON 配列。 一度に 100 件までセキュリティグループ ID を入力できます。 カンマ（、）で複数のセキュリティグループ ID を区切ります。

SecurityGroupName String No test1

セキュリティグループの名前。
Tag.N.Key String No FinanceDept

セキュリティグループの名前 N の有効値： 1 ～ 20。 タグキーを空の文字列にすることはできません。 長さは 64 文字以内である必要があります。先頭文字列を aliyun または acs：にすることはできません。 http:// または https:// を含めることはできません。

Tag.N.Value String No FinanceJoshua

セキュリティグループのタグ値 Nの有効値：1 ～ 20。 タグ値は、空の文字列が使用可能です。 長さは 128 文字以内である必要があります。先頭文字列を aliyun または acs：にすることはできません。 http:// または https:// を含めることはできません。

Tag.N.key String No FinanceDept

セキュリティグループのタグキー。

注 このパラメーターは削除予定です。 今後、互換性を確保するために、Tag.N.Key を使用することを推奨します。
Tag.N.value String No FinanceJoshua

セキュリティグループのタグ値 N の有効値：1 ～ 20。 空の文字列も使用可能です。 長さは 128 文字以内である必要があります。 先頭文字列を ”aliyun”、”acs:”、”http://“ 、または “https://“ にすることはできません。

注 このパラメーターは削除予定です。 今後、互換性を確保するため、Tag.N.Value を使用することを推奨します。
VpcId String No vpc-vpcid1

セキュリティーグループが属する VPC の ID。

応答パラメーター

パラメーター タイプ 例 説明
PageNumber Integer 1

返されたページ数。
PageSize Integer 10

返された各ページのエントリの数。
RegionId String cn-hangzhou

セキュリティグループのリージョン ID。
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

リクエストの ID。
セキュリティグループ

返されたセキュリティグループの情報。 SecurityGroups のデータからなる配列です。
└AvailableInstanceAmount Integer 880

セキュリティグループで利用可能なプライベート IP アドレスの数。
└CreationTime String 2017-12-05T22:40:00Z

セキュリティグループが作成された時刻。 時刻は ISO 8601 の標準時 ( yyyy-MM-ddThh：mmZ 形式) です。 時刻は UTC で表示されます。

└Description String FinanceDept

セキュリティグループの説明。
└ResourceGroupId String rg-resourcegroupid1

セキュリティグループが属するリソースグループの ID 。
└SecurityGroupId String sg-securitygroupid1

セキュリティグループの ID。
└SecurityGroupName String FinanceJoshua

セキュリティグループの名前。
└SecurityGroupType String normal

セキュリティグループのタイプ。 有効値：

  • normal：基本的なセキュリティグループ
  • enterprise：高度なセキュリティグループ
└Tags

セキュリティグループのタグ。
└TagKey String FinanceDept

セキュリティグループのタグ値。
└TagValue String FinanceJoshua

セキュリティグループのタグキー。
└VpcId String vpc-vpcid1

セキュリティーグループが属する VPC の ID。
TotalCount Integer 4

セキュリティグループの総数。

例

リクエストの例

https://ecs.aliyuncs.com/?Action=DescribeSecurityGroups
&RegionId=cn-hangzhou
&<Common request parameters>

通常の応答例

XML 形式 

<DescribeSecurityGroupsResponse>
  <RequestId>94D38899-626D-434A-891F-7E1F77A81525</RequestId>
   <TotalCount>4</TotalCount>
  <PageNumber>1</PageNumber>
  <PageSize>10</PageSize>
  <RegionId>cn-hangzhou</RegionId>
  <SecurityGroups>
    <SecurityGroup>
      <SecurityGroupId>sg-securityGroupId1</SecurityGroupId>
      <Description>Test</Description>
    </SecurityGroup>
    <SecurityGroup>
      <SecurityGroupId>sg-securityGroupId2</SecurityGroupId>
      <Description>test00212</Description>
    </SecurityGroup>
    <SecurityGroup>
      <SecurityGroupId>sg-securityGroupId3</SecurityGroupId>
      <Description>cn-hangzhou test group</Description>
    </SecurityGroup>
    <SecurityGroup>
      <SecurityGroupId>sg-securityGroupId4</SecurityGroupId>
      <Description>cn-hangzhou test group</Description>
    </SecurityGroup>
  </SecurityGroups>
 </DescribeSecurityGroupsResponse>

JSON 形式 

{
	 "PageNumber":"1",
	"TotalCount":1,
	"PageSize":10,
	"RegionId":"cn-hangzhou",
	"RequestId":"94D38899-626D-434A-891F-7E1F77A81525",
	"SecurityGroups":{
		"SecurityGroup":[
			{
				"SecurityGroupId":"sg-securityGroupId1",
				"Description":"TestByXcf"
			},
			{
				"SecurityGroupId":"sg-securityGroupId2",
				"Description":"test00212"
			},
			{
				"SecurityGroupId":"sg-securityGroupId3",
				"Description":"cn-hangzhou test group"
			},
			{
				"SecurityGroupId":"sg-securityGroupId4",
				"Description":"cn-hangzhou test group"
			}
		]
	}
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
500 InternalError 不明なエラーが発生したため、リクエスト処理に失敗しました。 内部エラーが発生した場合に返されるエラーメッセージ。 しばらくしてからもう一度お試しください。 問題が解決しない場合は、チケットを起票してください。

エラーコードの表示