GetBlackWhiteList - Microservices Engine - Alibaba Cloud Documentation Center

This API is deprecated. You are advised to use mse(2019-05-31) - GatewayBlackWhiteList.

Queries the blacklist or whitelist of a gateway.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
mse:GetBlackWhiteList	get	Gateway acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	No	The type of the resource.	GATEWAY
Type	string	No	The type.	IP
GatewayUniqueId	string	No	The unique ID of the gateway.	gw-32d5c9769c1842b1a2cc3426c59e****
IsWhite	boolean	No	Specifies whether to enable the whitelist.	true
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	The data structure.
RequestId	string	The ID of the request.	89CBC928-4F57-51FA-A413-EE0F4CD87200
HttpStatusCode	integer	The HTTP status code returned.	200
Message	string	The message returned.	You are not authorized to perform this operation.
Code	integer	The status code returned. A value of 200 indicates that the request is successful.	200
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	object	The data of the node.
Id	long	The ID.	275
ResourceId	long	The ID of the resource.	1
ResourceType	string	The type of a resource.	GATEWAY
Content	string	The content of the blacklist.	text
Type	string	The type.	IP
IsWhite	boolean	Indicates whether the whitelist is enabled.	true
Status	string	The status of the blacklist or whitelist.	on
GatewayId	long	The ID of the gateway.	1
GatewayUniqueId	string	The unique ID of the gateway.	gw-7ea3da97b96543e19f6c597c****
GmtCreate	string	The creation time.	2022-01-07T10:07:57.000+0000
GmtModified	string	The modification time.	2022-01-07T10:07:57.000+0000

Examples

Sample success responses

JSONformat

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

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
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
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-08-02	The API operation is deprecated	View Change Details