MongoDB API によるグローバル IP ホワイトリストテンプレートの取得 - MongoDB

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:DescribeGlobalSecurityIPGroup

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	インスタンスが属するリージョン ID。DescribeDBInstanceAttribute 操作を呼び出して、最新のリージョンリストを照会できます。	cn-hangzhou
GlobalSecurityGroupId	string	任意	IP ホワイトリストテンプレートの ID。	g-hedmu8kg9nsabw6u42rv

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの一意の ID。リクエストが失敗した場合は、この ID をテクニカルサポートに提供して、トラブルシューティングを依頼してください。	72651AF9-7897-41A7-8B67-6C15C7F26A0A
GlobalSecurityIPGroup	array<object>	グローバル IP ホワイトリストテンプレート。
	object	グローバル IP ホワイトリストテンプレート。
GlobalSecurityGroupId	string	IP ホワイトリストテンプレートの ID。	g-sdgwqyp4f5j1x3qk7yvm
GlobalIgName	string	IP ホワイトリストテンプレートの名前。	dev_baoxian_k8s_bj
GIpList	string	ホワイトリストテンプレート内の IP アドレス。説明複数の IP アドレスはコンマ (,) で区切ります。すべての IP アドレスホワイトリストに対して、最大 1,000 個の IP アドレスまたは CIDR ブロックを作成できます。	117.12.202.19
RegionId	string	インスタンスが属するリージョン ID。	cn-hangzhou
DBInstances	array	グローバルホワイトリストテンプレートに関連付けられているインスタンス。
	string	インスタンス ID。	[dds-asdxxxx,dds-afrexxxxxx]

例

成功レスポンス

JSONJSON

{
  "RequestId": "72651AF9-7897-41A7-8B67-6C15C7F26A0A",
  "GlobalSecurityIPGroup": [
    {
      "GlobalSecurityGroupId": "g-sdgwqyp4f5j1x3qk7yvm",
      "GlobalIgName": "dev_baoxian_k8s_bj",
      "GIpList": "117.12.202.19",
      "RegionId": "cn-hangzhou",
      "DBInstances": [
        "[dds-asdxxxx,dds-afrexxxxxx]"
      ]
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	RequiredParam.NotFound	Required input param is not found.
400	InvalidAction	Specified action is not valid.
404	InvalidUser.NotFound	Specified user does not exist.

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

変更履歴

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