GatewayBlackWhiteList - 擷取網關黑白名單列表 - Microservices Engine

擷取網關黑白名單列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

mse:GatewayBlackWhiteList

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
PageNumber	integer	否	當前頁數。取值範圍：大於 0 的整數。預設值：1。	1
PageSize	integer	否	每頁顯示條數。預設值：1。	1
FilterParams	object	否	parse from filterParams
GatewayId	integer	否	網關 ID。	81
GatewayUniqueId	string	否	網關唯一標識 ID（和 GatewayId 同時存在時優先使用 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	code 僅僅用來和 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
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	網關唯一標識 ID。	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	備忘。	禁止的IP列表
ResourceIdNameJson	string	資源名稱描述。	{}
Name	string	黑名單名稱。	test

樣本

正常返回樣本

JSON格式

{
  "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": "禁止的IP列表",
        "ResourceIdNameJson": "{}",
        "Name": "test"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	IllegalRequest	Invalid request:%s	非法請求： %s
400	InvalidParameter	Parameter error:%s	請求參數錯誤：%s
500	InternalError	Console error. Try again later:%s	控制台錯誤.稍後重試：%s
403	NoPermission	You are not authorized to perform this operation:%s	沒有許可權使用此介面：%s
404	NotFound	Not found:%s	資源不存在：%s

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。