セキュリティグループクエリ用の DescribeSecurityGroups API - ENS

作成されたセキュリティグループの詳細を照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ens:DescribeSecurityGroups

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SecurityGroupId	string	任意	セキュリティグループの ID。	sg-bp67acfmxazb4ph***
SecurityGroupName	string	任意	セキュリティグループの名前。	DocTest
PageSize	integer	任意	1ページあたりのエントリ数。最大値：50。デフォルト値：10	10
PageNumber	integer	任意	ページ番号。ページは 1 から始まります。デフォルト値：1	1

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageSize	integer	1ページあたりのエントリ数。	10
PageNumber	integer	ページ番号。	1
TotalCount	integer	返却されたページ総数です。	49
SecurityGroups	object
SecurityGroup	array<object>	セキュリティグループの詳細。
	array<object>
CreationTime	string	作成時間。時間は、YYYY-MM-DDThh:mm:ssZ 形式の ISO 8601 標準に準拠しています。時間は協定世界時 (UTC) で表示されます。	2019-11-01T06:08:46Z
InstanceCount	integer	関連付けられたインスタンスの数。	5
Description	string	セキュリティグループの説明。	TestDescription
SecurityGroupId	string	セキュリティグループの ID。	sg-bp67acfmxazb4ph***
SecurityGroupName	string	セキュリティグループの名前。	DocTest
InstanceIds	object
InstanceId	array	セキュリティグループに関連付けられているインスタンスの ID。
	string	インスタンスの ID。	i-5****
NetworkInterfaceIds	object
NetworkInterfaceId	array	セキュリティグループに関連付けられている ENI の ID。
	string	ENI の ID。	eni-5****

例

成功レスポンス

JSONJSON

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 49,
  "SecurityGroups": {
    "SecurityGroup": [
      {
        "CreationTime": "2019-11-01T06:08:46Z",
        "InstanceCount": 5,
        "Description": "TestDescription",
        "SecurityGroupId": "sg-bp67acfmxazb4ph***",
        "SecurityGroupName": "DocTest",
        "InstanceIds": {
          "InstanceId": [
            "i-5****"
          ]
        },
        "NetworkInterfaceIds": {
          "NetworkInterfaceId": [
            "eni-5****"
          ]
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	NoPermission	Permission denied.
400	CallInterface	Call Interface Happen Error.
400	ens.interface.error	Failed to call API.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

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

変更履歴

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