GatewayBlackWhiteList - Microservices Engine - Alibaba Cloud Documentation Center

Retrieves the gateway blacklists and whitelists.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mse:GatewayBlackWhiteList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number. Value range: integers greater than 0. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 1.	1
FilterParams	object	No	parse from filterParams
GatewayId	integer	No	The gateway ID.	81
GatewayUniqueId	string	No	The unique identifier of the gateway (when both GatewayId and GatewayUniqueId exist, GatewayId takes precedence).	gw-5017305290e14centbrveca****
ResourceType	string	No	Not available for use yet.	""
Type	string	No	Not available for use yet.	""
IsWhite	boolean	No	Not available for use yet.	""
SearchType	string	No	Search type: ROUTE: Search by route, fill in the route name in SearchContent DOMAIN: Search by domain name, fill in the domain name in SearchContent IP: Search by specified IP, fill in the IP in SearchContent	IP
SearchContent	string	No	Search content.	1.1.1.1
OrderItem	string	No	Not available for use yet.	""
DescSort	boolean	No	Not available for use yet.	""
AcceptLanguage	string	No	The language in which the returned results are displayed. Values: zh (default): Chinese, en: English	zh

Response elements

Parameter	Type	Description	Example
	object	RestResult<PageResult>
RequestId	string	The request ID.	58E06A0A-BD2C-47A0-99C2-B100F353****
Success	boolean	The result of the request. Valid values: `true`: The request was successful. `false`: The request failed.	true
Code	integer	The code is only used to synchronize with success	200
ErrorCode	string	The error code.	Success
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The returned message.	OK
DynamicCode	string	The placeholder in dynamic error messages. Not in use currently, please ignore.	code
DynamicMessage	string	Dynamic message. Not in use currently, please ignore.	The specified parameter is invalid.
Data	object	The returned data.
PageNumber	integer	The page number of the instance list	1
TotalSize	integer	The total number of instances found	1
PageSize	integer	The number of rows per page set during input	1
Result	array	The returned collection.
	object
Id	integer	The blacklist or whitelist ID.	549
ResourceId	integer	The resource ID.	549
ResourceType	string	Effective granularity: GATEWAY: Gateway global DOMAIN: Domain name ROUTE: Route	GATEWAY
Content	string	The blacklist content.	1.1.1.1
IsWhite	boolean	Indicates whether it is a whitelist.	true
Type	string	The blacklist or whitelist type, currently fixed as IP blacklist or whitelist.	IP
Status	string	The blacklist or whitelist status. on: Enabled off: Disabled	on
GatewayId	integer	The gateway ID.	81
GatewayUniqueId	string	The unique identifier of the gateway.	gw-5017305290e14centbrveca****
GmtCreate	string	The creation time.	2024-08-02T02:43:40.000+0000
GmtModified	string	The modification time.	2024-08-02T02:43:40.000+0000
ResourceIdJsonList	string	The JSON list of resource IDs. If ResourceType is ROUTE, this is a list of route IDs If ResourceType is DOMAIN, this is a list of domain name IDs	[234]
Note	string	The remarks.
ResourceIdNameJson	string	The resource name description.	{}
Name	string	The blacklist name.	test

Examples

Success response

JSON format

{
  "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"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.