DeleteBlackWhiteList - Microservices Engine - Alibaba Cloud Documentation Center

Deletes a blacklists and whitelists entry.

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:DeleteBlackWhiteList

delete

*Gateway

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	integer	No	The ID of the gateway.	430
Id	integer	No	The ID of the blacklists and whitelists entry.	120
GatewayUniqueId	string	No	The unique ID of the gateway.	gw-9cdcf8e4f58144059e73ff4c5ef9****
		No	The language of the response. Valid values: zh (default): Chinese, en: English.	zh

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	DC34E4A3-5F1C-4E40-86EA-02EDF967****
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The response message.	OK
Code	integer	The response code, which is used only to indicate whether the request is successful, similar to the Success parameter.	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 structure.
Id	integer	The ID of the blacklists and whitelists entry.	120
ResourceId	integer	Deprecated.	1
ResourceType	string	The granularity at which the blacklist or whitelist takes effect. Valid values: GATEWAY: gateway-wide DOMAIN: domain name ROUTE: route	GATEWAY
Content	string	The configuration content.	1.1.1.1
Type	string	Deprecated. A fixed value.	IP
IsWhite	boolean	Indicates whether the entry is a whitelist.	true
Status	boolean	The enabling status. Valid values: 0: disabled 1: enabled	1
GatewayId	integer	The ID of the gateway.	430
GatewayUniqueId	string	The unique ID of the gateway.	gw-9cdcf8e4f58144059e73ff4c5ef9****
GmtCreate	string	The creation time.	2022-08-10 20:22:34
GmtModified	string	The update time.	2022-08-10 20:22:34

Examples

Success response

JSON format

{
  "RequestId": "DC34E4A3-5F1C-4E40-86EA-02EDF967****",
  "HttpStatusCode": 200,
  "Message": "OK",
  "Code": 200,
  "Success": true,
  "Data": {
    "Id": 120,
    "ResourceId": 1,
    "ResourceType": "GATEWAY",
    "Content": "1.1.1.1",
    "Type": "IP",
    "IsWhite": true,
    "Status": true,
    "GatewayId": 430,
    "GatewayUniqueId": "gw-9cdcf8e4f58144059e73ff4c5ef9****",
    "GmtCreate": "2022-08-10 20:22:34",
    "GmtModified": "2022-08-10 20:22:34"
  }
}

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.