DescribeSecurityGroupAttribute を使用したセキュリティグループルールのクエリ - ENS

この API を呼び出して、セキュリティグループのルールを照会できます。

今すぐお試しください

この 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:DescribeSecurityGroupAttribute

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SecurityGroupId	string	必須	セキュリティグループの ID です。	sg-bp67acfmxazb4ph***

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID です。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Description	string	セキュリティグループの説明です。	testDescription1
SecurityGroupId	string	対象セキュリティグループの ID です。	sg-bp1gxw6bznjjvhu3****
SecurityGroupName	string	対象セキュリティグループの名前です。	testSecurityGroupName2
Permissions	object
Permission	array<object>	ルールの詳細です。
	object	応答スキーマです。
CreationTime	string	セキュリティグループルールが作成された時刻です。時刻は協定世界時 (UTC) で表示されます。	2018-12-12T07:28:38Z
Direction	string	セキュリティグループルールが適用される方向です。	ingress
Policy	string	ポリシーです。	Accept
PortRange	string	送信元ポート範囲です。	80/80
SourceCidrIp	string	インバウンドアクセス制御のための送信元 IP アドレス範囲です。	0.0.0.0/0
IpProtocol	string	トランスポート層プロトコルです。	TCP
DestCidrIp	string	アウトバウンドアクセス制御のための宛先 IP アドレス範囲です。	0.0.0.0/0
Priority	integer	ルールの優先度です。	1
SourcePortRange	string	セキュリティグループの送信元ポート番号範囲です。	22/22
Description	string	説明です。	testDescription1
Ipv6SourceCidrIp	string	送信元 IPv6 CIDR ブロックです。	::/0
Ipv6DestCidrIp	string	宛先 IPv6 CIDR ブロックです。	::/0

例

成功レスポンス

JSONJSON

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Description": "testDescription1",
  "SecurityGroupId": "sg-bp1gxw6bznjjvhu3****",
  "SecurityGroupName": "testSecurityGroupName2",
  "Permissions": {
    "Permission": [
      {
        "CreationTime": "2018-12-12T07:28:38Z",
        "Direction": "ingress",
        "Policy": "Accept",
        "PortRange": "80/80",
        "SourceCidrIp": "0.0.0.0/0",
        "IpProtocol": "TCP",
        "DestCidrIp": "0.0.0.0/0",
        "Priority": 1,
        "SourcePortRange": "22/22",
        "Description": "testDescription1",
        "Ipv6SourceCidrIp": "::/0",
        "Ipv6DestCidrIp": "::/0"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	NoPermission	Permission denied.
400	InvalidSecurityGroupId.NotFound	The specified SecurityGroupId does not exist.
400	IncorrectInstanceStatus	The current status of the resource does not support this operation.
400	CallInterface	Call Interface Happen Error.

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

変更履歴

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