调用GetBlackWhiteList查询网关黑白名单_微服务引擎(MSE)-阿里云帮助中心

目前该API接口已标记为弃用，推荐使用替代API：mse(2019-05-31) - GatewayBlackWhiteList。

查询网关黑白名单。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
mse:GetBlackWhiteList	get	*Gateway `acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}`	无	无

请求参数

名称	类型	必填	描述	示例值
ResourceType	string	否	范围类型。	GATEWAY
Type	string	否	类型。	IP
GatewayUniqueId	string	否	网关唯一标识 ID。	gw-32d5c9769c1842b1a2cc3426c59e****
IsWhite	boolean	否	是否白名单。	true
AcceptLanguage	string	否	返回信息的语言类型： zh：中文 en：英文	zh

返回参数

名称	类型	描述	示例值
	object	数据结构。
RequestId	string	请求 ID。	89CBC928-4F57-51FA-A413-EE0F4CD87200
HttpStatusCode	integer	HTTP 状态码。	200
Message	string	响应信息。	You are not authorized to perform this operation.
Code	integer	状态码。说明 200 表示成功。	200
Success	boolean	请求结果，取值如下： `true`：请求成功。 `false`：请求失败。	true
Data	object	节点数据。
Id	long	ID。	275
ResourceId	long	资源 ID。	1
ResourceType	string	资源类型。	GATEWAY
Content	string	黑名单内容。	text
Type	string	类型。	IP
IsWhite	boolean	是否为白名单。	true
Status	string	黑白名单状态。	on
GatewayId	long	网关 id。	1
GatewayUniqueId	string	网关唯一标识 ID。	gw-7ea3da97b96543e19f6c597c****
GmtCreate	string	创建时间。	2022-01-07T10:07:57.000+0000
GmtModified	string	更新时间	2022-01-07T10:07:57.000+0000

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

变更时间	变更内容概要	操作
2024-08-02	OpenAPI 变更为 deprecated，即将下线	查看变更详情