全部产品
Search
文档中心

微服务引擎MSE:AddBlackWhiteList - 添加黑白名单

更新时间:Nov 20, 2024

添加黑白名单。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mse:AddBlackWhiteList
*Gateway
acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

请求参数

名称类型必填描述示例值
GatewayUniqueIdstring

网关唯一标识 ID。

gw-0fe488252dc44d55a9dd57875193****
ResourceTypestring

生效粒度:

  • GATEWAY:网关全局
  • DOMAIN:域名
  • ROUTE:路由
GATEWAY
Typestring

黑白名单类型。

IP
Contentstring

黑名单内容。

1.117.115.51
Statusstring

黑名单状态描述。

  • on 开启
  • off 关闭
off
IsWhiteboolean

是否白名单(默认为否)。

false
ResourceIdJsonListstring

资源 ID 列表 JSON。

[123]
Notestring

备注。

this is a note
Namestring

名称。

name
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

数据结构。

RequestIdstring

请求 ID。

966F6CA7-16D0-50AB-AB02-E140934F90C1
HttpStatusCodeinteger

HTTP 状态码

200
Messagestring

错误信息。

You are not authorized to perform this operation.
Codeinteger

返回码。

200
Successboolean

请求结果,取值如下:

  • true:请求成功。
  • false:请求失败。
true
Datalong

记录 ID。

2

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400IllegalRequestInvalid request:%s非法请求: %s
400InvalidParameterParameter error:%s请求参数错误:%s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口:%s
404NotFoundNot found:%s资源不存在:%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试:%s

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