すべてのプロダクト
Search

このプロダクト

    Elastic Compute Service:DescribeSecurityGroups

    ドキュメントセンター

    Elastic Compute Service:DescribeSecurityGroups

    最終更新日:Jun 29, 2026

    セキュリティグループの基本情報を照会します。リージョン、セキュリティグループ ID、セキュリティグループタイプなどのパラメーターで結果をフィルターできます。

    操作説明

    • ページングクエリ: MaxResults と NextToken を使用してページングクエリを行います。

      • NextToken が返されない場合、現在のページが最後のページです。

      • 最初のページでは、MaxResults のみをセットして返すエントリ数を制限します。応答の NextToken 値を使用して後続のページを照会します。

      • 後続のページでは、NextToken を前の応答で返された NextToken 値にセットし、MaxResults をセットして返すエントリ数を制限します。

    • クラウドアシスタント CLI を使用して API オペレーションを呼び出す場合、必須の形式でリクエストパラメーターを指定してください。詳細については、CLI コマンドのパラメーター形式を参照してください。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ecs:DescribeSecurityGroups

    get

    SecurityGroup

    acs:ecs:{#regionId}:{#accountId}:securitygroup/*

    SecurityGroup

    acs:ecs:{#regionId}:{#accountId}:securitygroup/{#securitygroupId}
    • ecs:tag
    • ecs:tag
    • ecs:tag
    • ecs:tag
    		 なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。 DescribeRegions を呼び出して最新のリージョンリストをクエリできます。

    cn-hangzhou
    SecurityGroupIds

    string

    任意

    セキュリティグループの ID。最大 100 個のセキュリティグループ ID を指定できます。複数の ID は JSON 配列形式でカンマ (,) で区切ります。

    ["sg-bp67acfmxazb4p****", "sg-bp67acfmxazb4p****", "sg-bp67acfmxazb4p****",....]
    VpcId

    string

    任意

    セキュリティグループが属する仮想プライベートクラウド (VPC) の ID。

    vpc-bp67acfmxazb4p****
    SecurityGroupType

    string

    任意

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

    • normal: 基本セキュリティグループ。

    • enterprise: 高度セキュリティグループ。

    説明

    このパラメーターを指定しない場合、すべてのタイプのセキュリティグループが照会されます。

    normal
    NextToken

    string

    任意

    ページネーショントークン。このパラメーターを前のリクエストで返された NextToken 値に設定します。最初のリクエストではこのパラメーターを設定する必要はありません。

    e71d8a535bd9cc11
    MaxResults

    integer

    任意

    ページングクエリの 1 ページあたりの最大エントリ数。このパラメーターをセットすると、MaxResults と NextToken によるページングメソッドが使用されます。

    最大値: 100。

    デフォルト値: 10。

    10
    NetworkType

    string

    任意

    セキュリティグループのネットワークタイプ。有効な値:

    • vpc: VPC。

    • classic: クラシックネットワーク。クラシックネットワークは非推奨です。詳細については、廃止のお知らせを参照してください。

    vpc
    SecurityGroupName

    string

    任意

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

    SGTestName
    IsQueryEcsCount

    boolean

    任意

    セキュリティグループの容量情報をクエリするかどうかを指定します。このパラメーターを True に設定すると、応答の EcsCount と AvailableInstanceAmount の値が有効になります。

    説明

    このパラメーターは非推奨です。

    null
    ResourceGroupId

    string

    任意

    セキュリティグループが属するリソースグループの ID。このパラメーターを使用してリソースをフィルターする場合、リソース数は 1,000 を超えることはできません。 ListResourceGroups を呼び出してリソースグループをクエリできます。

    説明

    デフォルトのリソースグループによるフィルタリングはサポートされていません。

    rg-bp67acfmxazb4p****
    Tag

    array<object>

    任意

    タグ。

    object

    任意

    タグ。

    key

    string

    任意

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

    説明

    互換性を高めるため、Tag.N.Key パラメーターを使用してください。

    testkey
    Key

    string

    任意

    セキュリティグループのタグキー。N の有効な値: 1～20。

    単一のタグを使用してリソースをフィルターする場合、指定されたタグを持つリソース数は 1,000 を超えることはできません。複数のタグを使用してリソースをフィルターする場合、指定されたすべてのタグが付与されたリソース数は 1,000 を超えることはできません。リソース数が 1,000 を超える場合は、 ListTagResources を呼び出してリソースをクエリしてください。

    TestKey
    Value

    string

    任意

    セキュリティグループのタグ値。N の有効な値: 1～20。

    TestValue
    value

    string

    任意

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

    説明

    互換性を高めるため、Tag.N.Value パラメーターを使用してください。

    testvalue
    DryRun

    boolean

    任意

    ドライランのみを実行するかどうかを指定します。有効な値:

    • true: ドライランのみを実行します。システムは、無効な AccessKey ペア、未権限付与の Resource Access Management (RAM) ユーザー、欠落しているパラメーター値など、リクエストの潜在的な問題をチェックします。リクエストがドライランに失敗した場合、エラーメッセージが返されます。リクエストがドライランに合格した場合、DryRunOperation エラーコードが返されます。

    • false: ドライランを実行し、通常リクエストを送信します。リクエストがドライランに合格した場合、2xx HTTP 状態コードが返され、権限付与が検証されます。

    デフォルト値: false。

    false
    SecurityGroupId

    string

    任意

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

    sg-bp67acfmxazb4p****
    FuzzyQuery

    boolean

    任意

    説明

    このパラメーターは非推奨です。

    null
    PageNumber

    integer

    任意

    説明

    このパラメーターはオフラインになります。ページングには NextToken と MaxResults を使用してください。

    1
    PageSize

    integer

    任意

    説明

    このパラメーターはオフラインになります。ページングには NextToken と MaxResults を使用してください。

    10
    ServiceManaged

    boolean

    任意

    マネージドセキュリティグループが管理されているかどうかを指定します。有効な値:

    • true: マネージドセキュリティグループは管理されています。

    • false: マネージドセキュリティグループは管理されていません。

    false

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    RegionId

    string

    セキュリティグループのリージョン ID。

    cn-hangzhou
    NextToken

    string

    この呼び出しで返されたページネーショントークン。MaxResults と NextToken を使用してページングする際にこの値が空の場合、利用可能なデータはこれ以上ありません。

    e71d8a535bd9cc11
    SecurityGroups

    object

    SecurityGroup

    array<object>

    セキュリティグループ情報のコレクション。

    array<object>

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

    SecurityGroupId

    string

    セキュリティグループ ID。

    sg-bp67acfmxazb4p****
    SecurityGroupName

    string

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

    SGTestName
    Description

    string

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

    TestDescription
    SecurityGroupType

    string

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

    • normal: 基本セキュリティグループ。

    • enterprise: 高度セキュリティグループ。

    normal
    VpcId

    string

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

    vpc-bp67acfmxazb4p****
    CreationTime

    string

    セキュリティグループが作成された時間。時間は ISO 8601 標準に従い、協定世界時 (UTC) で表されます。初期化: yyyy-MM-ddThh:mmZ。

    2021-08-31T03:12:29Z
    EcsCount

    integer

    セキュリティグループに収容されるプライベート IP アドレスの数。詳細については、セキュリティグループの容量を参照してください。

    このパラメーターは、IsQueryEcsCount リクエストパラメーターが True にセットされている場合にのみ有効です。

    説明

    このパラメーターは非推奨です。応答の数量は参考値であり、リアルタイムで一致しません。

    0
    AvailableInstanceAmount

    integer

    セキュリティグループにまだ追加できるプライベート IP アドレスの数。詳細については、セキュリティグループの容量を参照してください。

    このパラメーターは、IsQueryEcsCount リクエストパラメーターが True にセットされている場合にのみ有効です。

    説明

    このパラメーターは非推奨です。応答の数量は参考値であり、リアルタイムで一致しません。

    0
    ResourceGroupId

    string

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

    rg-bp67acfmxazb4p****
    ServiceManaged

    boolean

    セキュリティグループがクラウドサービスまたはディストリビューターによって使用されているかどうかを示します。

    false
    ServiceID

    integer

    セキュリティグループに関連付けられたディストリビューター ID。

    12345678910
    Tags

    object

    Tag

    array<object>

    セキュリティグループのタグのコレクション。

    object

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

    TagValue

    string

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

    TestValue
    TagKey

    string

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

    TestKey
    RuleCount

    integer

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

    100
    GroupToGroupRuleCount

    integer

    他のセキュリティグループからのアクセスを許可するルールの数。

    5
    TotalCount

    integer

    セキュリティグループの総数。MaxResults と NextToken を使用してパラメータークエリを行う場合、このパラメーターは返されません。

    20
    PageNumber

    integer

    現在のページ番号。

    説明

    このパラメーターはオフラインになります。ページングには NextToken と MaxResults を使用してください。

    1
    PageSize

    integer

    1 ページあたりのエントリ数。

    説明

    このパラメーターはオフラインになります。ページングには NextToken と MaxResults を使用してください。

    10

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "RegionId": "cn-hangzhou",
  "NextToken": "e71d8a535bd9cc11",
  "SecurityGroups": {
    "SecurityGroup": [
      {
        "SecurityGroupId": "sg-bp67acfmxazb4p****",
        "SecurityGroupName": "SGTestName",
        "Description": "TestDescription",
        "SecurityGroupType": "normal",
        "VpcId": "vpc-bp67acfmxazb4p****",
        "CreationTime": "2021-08-31T03:12:29Z",
        "EcsCount": 0,
        "AvailableInstanceAmount": 0,
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "ServiceManaged": false,
        "ServiceID": 12345678910,
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "RuleCount": 100,
        "GroupToGroupRuleCount": 5
      }
    ]
  },
  "TotalCount": 20,
  "PageNumber": 1,
  "PageSize": 10
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 NotSupported.PageNumberAndPageSize The parameters PageNumber and PageSize are currently not supported, please use NextToken and MaxResults instead.
    400 InValidParameter.NextToken The parameter NextToken is invalid.
    400 MissingParameter.RegionId The input parameter RegionId that is mandatory for processing this request is not supplied.
    400 InvalidParameter.SecurityGroupType The specified SecurityGroupType is not valid.
    400 InvalidSecurityGroupId.Malformed The specified parameter SecurityGroupId is not valid.
    400 InvalidSecurityGroupName.Malformed The specified parameter SecurityGroupName is not valid.
    500 InternalError The request processing has failed due to some unknown error.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。