文档

GetBlackWhiteList - 查询网关黑白名单

更新时间:

查询网关黑白名单。

调试

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

授权信息

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

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

请求参数

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

范围类型。

GATEWAY
Typestring

类型。

IP
GatewayUniqueIdstring

网关唯一标识 ID。

gw-32d5c9769c1842b1a2cc3426c59e****
IsWhiteboolean

是否白名单。

true
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

数据结构。

RequestIdstring

请求 ID。

89CBC928-4F57-51FA-A413-EE0F4CD87200
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

响应信息。

You are not authorized to perform this operation.
Codeinteger

状态码。说明 200 表示成功。

200
Successboolean

请求结果,取值如下:

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

节点数据。

Idlong

ID。

275
ResourceIdlong

资源 ID。

1
ResourceTypestring

资源类型。

GATEWAY
Contentstring

黑名单内容。

text
Typestring

类型。

IP
IsWhiteboolean

是否为白名单。

true
Statusstring

黑白名单状态。

on
GatewayIdlong

网关 id。

1
GatewayUniqueIdstring

网关唯一标识 ID。

gw-7ea3da97b96543e19f6c597c****
GmtCreatestring

创建时间。

2022-01-07T10:07:57.000+0000
GmtModifiedstring

更新时间

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错误码错误信息描述
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

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