すべてのプロダクト
Search
ドキュメントセンター

ApsaraDB for MongoDB:DescribeSecurityIps

最終更新日:Mar 26, 2026

ApsaraDB for MongoDB インスタンスの IP ホワイトリストを取得します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dds:DescribeSecurityIps

get

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

DBInstanceId

string

必須

インスタンスの ID。

dds-bpxxxxxxxx

ShowHDMIps

boolean

任意

DAS ホワイトリスト情報を表示するかどうか。

列挙値:

  • true :

    true

  • false :

    false

true

レスポンスフィールド

フィールド

説明

object

SecurityIps

string

デフォルトのホワイトリスト内の IP アドレス。

47.xxx.xxx.xx,100.xxx.xxx.0/24

RequestId

string

リクエストの ID。

FC724D23-2962-479E-ABB1-606C935AE7FD

SecurityIpGroups

object

SecurityIpGroup

array<object>

IP ホワイトリストの情報で構成される配列。

object

SecurityIpGroupName

string

IP ホワイトリストの名前。

default

SecurityIpGroupAttribute

string

IP アドレスホワイトリストの属性。

hidden

SecurityIpList

string

IP ホワイトリストの名前。

47.xxx.xxx.xx,100.xxx.xxx.0/24

成功レスポンス

JSONJSON

{
  "SecurityIps": "47.xxx.xxx.xx,100.xxx.xxx.0/24",
  "RequestId": "FC724D23-2962-479E-ABB1-606C935AE7FD",
  "SecurityIpGroups": {
    "SecurityIpGroup": [
      {
        "SecurityIpGroupName": "default",
        "SecurityIpGroupAttribute": " hidden",
        "SecurityIpList": "47.xxx.xxx.xx,100.xxx.xxx.0/24"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidDBInstance.Malformed Too many instance ids or instance id format is invalid.

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

変更履歴

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