ゲートウェイブラックリストとホワイトリストアクセス制御 API 概要 - Microservices Engine (MSE)

ゲートウェイのブラックリストまたはホワイトリストを照会します。

説明

この API は廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。代わりに mse(2019-05-31) - GatewayBlackWhiteList への移行を推奨します。より強化された機能に加え、サポートも引き続きご利用いただけます。

今すぐお試しください

この 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:GetBlackWhiteList

get

*Gateway

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ResourceType	string	任意	リソースのタイプ。	GATEWAY
Type	string	任意	タイプ。	IP
GatewayUniqueId	string	任意	ゲートウェイの一意の ID。	gw-32d5c9769c1842b1a2cc3426c59e****
IsWhite	boolean	任意	ホワイトリストを有効にするかどうかを指定します。	true
AcceptLanguage	string	任意	応答の言語。有効な値： zh：中国語 en：英語	zh

レスポンスフィールド

フィールド	型	説明	例
	object	データ構造。
RequestId	string	リクエスト ID。	89CBC928-4F57-51FA-A413-EE0F4CD87200
HttpStatusCode	integer	返される HTTP ステータスコード。	200
Message	string	返されるメッセージ。	You are not authorized to perform this operation.
Code	integer	返されるステータスコード。値が 200 の場合は、リクエストが成功したことを示します。	200
Success	boolean	リクエストが成功したかどうかを示します。有効な値： `true`：リクエストは成功しました。 `false`：リクエストは失敗しました。	true
Data	object	ノードのデータ。
Id	integer	ID。	275
ResourceId	integer	リソースの ID。	1
ResourceType	string	リソースのタイプ。	GATEWAY
Content	string	ブラックリストのコンテンツ。	text
Type	string	タイプ。	IP
IsWhite	boolean	ホワイトリストが有効になっているかどうかを示します。	true
Status	string	ブラックリストまたはホワイトリストのステータス。	on
GatewayId	integer	ゲートウェイの ID。	1
GatewayUniqueId	string	ゲートウェイの一意の ID。	gw-7ea3da97b96543e19f6c597c****
GmtCreate	string	作成時間。	2022-01-07T10:07:57.000+0000
GmtModified	string	変更時間。	2022-01-07T10:07:57.000+0000

例

成功レスポンス

JSONJSON

{
  "RequestId": "89CBC928-4F57-51FA-A413-EE0F4CD87200",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation. ",
  "Code": 200,
  "Success": true,
  "Data": {
    "Id": 275,
    "ResourceId": 1,
    "ResourceType": "GATEWAY",
    "Content": "text",
    "Type": "IP",
    "IsWhite": true,
    "Status": "on",
    "GatewayId": 1,
    "GatewayUniqueId": "gw-7ea3da97b96543e19f6c597c****",
    "GmtCreate": "2022-01-07T10:07:57.000+0000",
    "GmtModified": "2022-01-07T10:07:57.000+0000"
  }
}

エラーコード

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

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

変更履歴

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