DescribeGlobalSecurityIPGroup - Tair (Redis® OSS-Compatible) - Alibaba Cloud ドキュメントセンター

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

kvstore:DescribeGlobalSecurityIPGroup

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ResourceGroupId	string	任意	リソースグループの ID です。	rg-acfmyiu4ekp****
RegionId	string	必須	リージョンの ID です。	cn-hangzhou
GlobalSecurityGroupId	string	任意	グローバル IP ホワイトリストテンプレートの ID です。	g-zsldxfiwjmti0kcm****
Engine	string	任意

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID です。	2FF6158E-3394-4A90-B634-79C49184****
GlobalSecurityIPGroup	array<object>	グローバル IP ホワイトリストテンプレートの配列です。
	object
GlobalSecurityGroupId	string	グローバル IP ホワイトリストテンプレートの ID です。	g-zsldxfiwjmti0kcm****
GlobalIgName	string	グローバル IP ホワイトリストテンプレートの名前です。	test_123
GIpList	string	グローバル IP ホワイトリストテンプレートに登録された IP アドレスです。説明複数の IP アドレスはカンマで区切ります。	192.168.0.1,10.10.10.10
RegionId	string	リージョンの ID です。	cn-hangzhou
DBInstances	array	このグローバル IP ホワイトリストテンプレートに関連付けられたインスタンス ID の配列です。
	string	インスタンスの ID です。	r-t4n885e834f6****

例

成功レスポンス

JSONJSON

{
  "RequestId": "2FF6158E-3394-4A90-B634-79C49184****",
  "GlobalSecurityIPGroup": [
    {
      "GlobalSecurityGroupId": "g-zsldxfiwjmti0kcm****",
      "GlobalIgName": "test_123",
      "GIpList": "192.168.0.1,10.10.10.10",
      "RegionId": "cn-hangzhou",
      "DBInstances": [
        "r-t4n885e834f6****"
      ]
    }
  ]
}

エラーコード

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.

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

変更履歴

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