GatewayBlackWhiteList - 获取网关黑白名单列表 - 微服务引擎MSE

获取网关黑白名单列表。

调试

您可以在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	long	否	网关 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>	返回集合。
Result	object
Id	long	黑白名单 ID。	549
ResourceId	long	资源 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	long	网关 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
403	NoPermission	You are not authorized to perform this operation:%s	没有权限使用此接口：%s
404	NotFound	Not found:%s	资源不存在：%s
500	InternalError	Console error. Try again later:%s	控制台错误.稍后重试：%s

访问错误中心查看更多错误码。