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

Microservices Engine:GatewayBlackWhiteList

最終更新日:Jun 01, 2026

ゲートウェイのブラックリストとホワイトリストを取得します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

mse:GatewayBlackWhiteList

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

PageNumber

integer

任意

ページ番号。有効値: 0 より大きい整数。 デフォルト値: 1。

1

PageSize

integer

任意

1 ページあたりのエントリ数。デフォルト値: 1。

1

FilterParams

object

任意

filterParams から解析

GatewayId

integer

任意

ゲートウェイ ID。

81

GatewayUniqueId

string

任意

ゲートウェイの一意の識別子( GatewayId と GatewayUniqueId の両方が存在する場合、 GatewayId が優先されます)。

gw-5017305290e14centbrveca****

ResourceType

string

任意

まだ使用できません。

""

Type

string

任意

まだ使用できません。

""

IsWhite

boolean

任意

まだ使用できません。

""

SearchType

string

任意

検索タイプ:

  • ROUTE: ルートで検索し、 SearchContent にルート名を入力します

  • DOMAIN: ドメイン名で検索し、 SearchContent にドメイン名を入力します

  • IP: 指定された IP で検索し、 SearchContent に IP を入力します

IP

SearchContent

string

任意

検索コンテンツ。

1.1.1.1

OrderItem

string

任意

まだ使用できません。

""

DescSort

boolean

任意

まだ使用できません。

""

AcceptLanguage

string

任意

返される結果が表示される言語。値: zh (デフォルト): 中国語、 en: 英語

zh

レスポンスフィールド

パラメーター

説明

object

RestResult<PageResult>

RequestId

string

リクエスト ID。

58E06A0A-BD2C-47A0-99C2-B100F353****

Success

boolean

リクエストの結果。有効値:

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

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

true

Code

integer

コードは success と同期するためにのみ使用されます

200

ErrorCode

string

エラーコード。

Success

HttpStatusCode

integer

HTTP ステータスコード。

200

Message

string

返されたメッセージ。

OK

DynamicCode

string

動的エラーメッセージのプレースホルダー。現在使用されていないため、無視してください。

code

DynamicMessage

string

動的メッセージ。現在使用されていないため、無視してください。

The specified parameter is invalid.

Data

object

返されたデータ。

PageNumber

integer

インスタンスリストのページ番号

1

TotalSize

integer

見つかったインスタンスの総数

1

PageSize

integer

入力時に設定された 1 ページあたりの行数

1

Result

array

返されたコレクション。

object

Id

integer

ブラックリストまたはホワイトリスト ID。

549

ResourceId

integer

リソース ID。

549

ResourceType

string

有効な粒度:

  • GATEWAY: ゲートウェイグローバル

  • DOMAIN: ドメイン名

  • ROUTE: ルート

GATEWAY

Content

string

ブラックリストコンテンツ。

1.1.1.1

IsWhite

boolean

ホワイトリストかどうかを示します。

true

Type

string

ブラックリストまたはホワイトリストのタイプ。現在は IP ブラックリストまたはホワイトリストに固定されています。

IP

Status

string

ブラックリストまたはホワイトリストのステータス。

  • on: 有効

  • off: 無効

on

GatewayId

integer

ゲートウェイ ID。

81

GatewayUniqueId

string

ゲートウェイの一意の識別子。

gw-5017305290e14centbrveca****

GmtCreate

string

作成時間。

2024-08-02T02:43:40.000+0000

GmtModified

string

変更時間。

2024-08-02T02:43:40.000+0000

ResourceIdJsonList

string

リソース ID の JSON リスト。

  • ResourceType が ROUTE の場合、これはルート ID のリストです

  • ResourceType が DOMAIN の場合、これはドメイン名 ID のリストです

[234]

Note

string

備考。

ResourceIdNameJson

string

リソース名説明。

{}

Name

string

ブラックリスト名。

test

成功レスポンス

JSONJSON

{
  "RequestId": "58E06A0A-BD2C-47A0-99C2-B100F353****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "Success",
  "HttpStatusCode": 200,
  "Message": "OK",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": {
    "PageNumber": 1,
    "TotalSize": 1,
    "PageSize": 1,
    "Result": [
      {
        "Id": 549,
        "ResourceId": 549,
        "ResourceType": "GATEWAY",
        "Content": "1.1.1.1",
        "IsWhite": true,
        "Type": "IP",
        "Status": "on",
        "GatewayId": 81,
        "GatewayUniqueId": "gw-5017305290e14centbrveca****",
        "GmtCreate": "2024-08-02T02:43:40.000+0000",
        "GmtModified": "2024-08-02T02:43:40.000+0000",
        "ResourceIdJsonList": "[234]",
        "Note": "",
        "ResourceIdNameJson": "{}",
        "Name": "test"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 IllegalRequest Invalid request:%s
400 InvalidParameter Parameter error:%s
500 InternalError Console error. Try again later:%s
403 NoPermission You are not authorized to perform this operation:%s
404 NotFound Not found:%s

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

変更履歴

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