AddBlackWhiteList - Microservices Engine - Alibaba Cloud Documentation Center

Creates a blacklist or a whitelist.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:AddBlackWhiteList	Write	Gateway acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
GatewayUniqueId	string	Yes	The unique ID of the gateway.	gw-0fe488252dc44d55a9dd57875193****
ResourceType	string	No	The effective scope of the blacklist or whitelist. Valid values: GATEWAY DOMAIN ROUTE	GATEWAY
Type	string	No	The type of object in the blacklist or whitelist.	IP
Content	string	No	The content of the blacklist.	1.117.115.51
Status	string	No	The status of the blacklist. on: enabled off: disabled	off
IsWhite	boolean	No	The whitelist. Default value: No.	false
ResourceIdJsonList	string	No	The resource IDs in the JSON format.	[123]
Note	string	No	The description.	this is a note
Name	string	No	The name.	name
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.	966F6CA7-16D0-50AB-AB02-E140934F90C1
HttpStatusCode	integer	The HTTP status code returned.	200
Message	string	The error message.	You are not authorized to perform this operation.
Code	integer	The status code returned.	200
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	long	The ID of the record.	2

Examples

Sample success responses

JSONformat

{
  "RequestId": "966F6CA7-16D0-50AB-AB02-E140934F90C1",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation.",
  "Code": 200,
  "Success": true,
  "Data": 2
}

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.