すべてのプロダクト
Search

このプロダクト

    Database Autonomy Service:DescribeSecurityIPGroup

    ドキュメントセンター

    Database Autonomy Service:DescribeSecurityIPGroup

    最終更新日:Aug 22, 2026

    ユーザーのクロスエンジンホワイトリストテンプレートの詳細を表示します。

    操作説明

    開始する前に:

    • Alibaba Cloud または DAS SDK の最新バージョンを使用してください。

    • SDK を使用して DAS を呼び出す場合は、リージョンを cn-shanghai に設定してください。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    hdm:DescribeSecurityIPGroup

    get

    *すべてのリソース。

    *

    		 なし なし

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionName

    string

    必須

    リージョン ID。

    cn-shanghai

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    Code

    string

    返される状態コード。

    200
    Data

    object

    ListResult

    SecurityIpGroups

    array<object>

    指定されたリージョンにおけるユーザーのすべてのクロスエンジンホワイトリストテンプレートのリスト。

    array<object>

    DbInstances

    array

    クロスエンジンホワイトリストテンプレートにバインドされているデータベースインスタンスのリスト。

    string

    データベースインスタンスの ID。

    ["r-2ze9g6mnhu1***", "pc-2zew5qn1m***", "r-2ze9g6mn****", "pc-2zew5qh41*****"]
    SecurityIpType

    string

    IP タイプ。

    ipv4
    Uid

    string

    アカウント ID。Alibaba Cloud コンソールの アカウント管理 の セキュリティ設定項目 ページで ログインアカウント の ID を取得できます。

    160-79abe3f4****
    RegionId

    string

    リージョン ID。

    cn-hangzhou
    GEcsSgIdList

    string

    ECS セキュリティグループ ID。このフィールドは無効であり、非推奨となる冗長なデータが含まれています。

    null
    GlobalIgName

    string

    IP ホワイトリストテンプレート名。名前は以下の要件を満たす必要があります。

    • 小文字、数字、アンダースコア (_) のみを含むこと。

    • 英字で始まり、英字または数字で終わること。

    • 長さが 2 ～ 120 文字であること。

    test_123
    GlobalSecurityGroupId

    string

    IP ホワイトリストテンプレートの ID。

    g-1no2rzybnqcv****
    WhitelistNetType

    string

    ホワイトリストのネットワークタイプ。

    mix
    EngineInfoList

    array<object>

    テンプレートにバインドされている各プロダクトのインスタンス情報。

    object

    InstanceNum

    integer

    現在のログインアカウント配下のインスタンス数。

    10
    EngineName

    string

    ターゲットインスタンスのデータベースエンジンタイプ。

    PolarDBMySQL
    InstanceIds

    array

    データベースインスタンス ID のリスト。

    string

    データベースインスタンスの ID。

    説明

    データは JSONArray フォーマットです (例: ['Instance ID 1','Instance ID 2'])。複数のインスタンス ID はカンマ (,) で区切ります。

    rm-2ze8ygcc****
    UserId

    string

    ユーザー ID。

    641***
    GIpList

    string

    ホワイトリストテンプレート内の IP アドレス。

    説明

    複数の IP アドレスはカンマ (,) で区切ります。

    192.168.1.28/32
    Message

    string

    リクエストに対して返されるメッセージ。

    説明

    リクエストが成功した場合、Successful が返されます。リクエストが失敗した場合、エラーコードなどの例外メッセージが返されます。

    Successful
    RequestId

    string

    リクエスト ID。

    CAC553F1-C669-53F1-A295-2CF050E****
    Success

    string

    リクエストが成功したかどうかを示します。有効な値:

    • true: リクエストが成功しました。

    • false: リクエストが失敗しました。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "Code": "200",
  "Data": {
    "SecurityIpGroups": [
      {
        "DbInstances": [
          "[\"r-2ze9g6mnhu1***\",\n\"pc-2zew5qn1m***\",\n\"r-2ze9g6mn****\",\n\"pc-2zew5qh41*****\"]"
        ],
        "SecurityIpType": "ipv4",
        "Uid": "160-79abe3f4****",
        "RegionId": "cn-hangzhou",
        "GEcsSgIdList": " null",
        "GlobalIgName": "test_123",
        "GlobalSecurityGroupId": "g-1no2rzybnqcv****",
        "WhitelistNetType": "mix",
        "EngineInfoList": [
          {
            "InstanceNum": 10,
            "EngineName": "PolarDBMySQL",
            "InstanceIds": [
              "rm-2ze8ygcc****"
            ]
          }
        ],
        "UserId": "641***",
        "GIpList": "192.168.1.28/32"
      }
    ]
  },
  "Message": "Successful",
  "RequestId": "CAC553F1-C669-53F1-A295-2CF050E****",
  "Success": "true"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidParams The request parameters are invalid. リクエストパラメーターが無効です。
    403 NoPermission You are not authorized to do this action. この操作を実行する権限がありません。

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

    変更履歴

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