すべてのプロダクト
Search

このプロダクト

    Database Autonomy Service:DescribeSecurityIPGroup

    ドキュメントセンター

    Database Autonomy Service:DescribeSecurityIPGroup

    最終更新日:Mar 13, 2026

    クロスプロダクトホワイトリストテンプレートの詳細を照会します。

    操作説明

    この操作を呼び出す前に、次の点にご注意ください。

    • 最新バージョンの Alibaba Cloud ソフトウェア開発キット (SDK) または 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

    *All Resource

    *

    		 なし なし

    リクエスト構文

    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。 [アカウント管理] の [セキュリティ設定] ページで、ログインアカウントの 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。

    説明

    値は ['Instance ID1','Instance ID2'] のような JSON 配列です。 複数のインスタンス 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.

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

    変更履歴

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