DescribeUserIPSWhitelist - 获取用户IPS白名单

查询互联网边界IPS白名单。

接口说明

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

SourceIp

string

访问者源 IP 地址。

47.100.XX.XX

Lang

string

语言。

枚举值:

  • en :

    英文

  • zh :

    中文(默认)

zh

Lang

string

语言。

枚举值:

  • en :

    英文

  • zh :

    中文(默认)

zh

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

04F788A5-6A47-5EA9-AC30-CA4DB98AD520

Whitelists

array<object>

互联网边界 IPv4 的入侵防御系统白名单列表。

object

互联网边界 IPv4 的入侵防御系统白名单。

Direction

integer

互联网边界的 IPv4 流量方向。

枚举值:

  • 1 :

    入向

  • 2 :

    出向

1

WhiteType

integer

互联网边界 IPv4 白名单生效的源或目的类型。

枚举值:

  • 1 :

    目的 IP 白名单

  • 2 :

    源 IP 白名单

1

ListValue

string

互联网边界 IPv4 白名单的值。

  • 当白名单类型为自定义输入时:地址簿名称。

  • 当白名单类型为地址簿引用时:IPv4。

10.10.200.4/32,10.10.200.25/32

ListType

integer

互联网 IPv4 白名单地址的类型。

枚举值:

  • 0 :

    暂不设置

  • 1 :

    自定义输入

  • 2 :

    地址簿引用

1

WhiteListValue

array

互联网 IPv4 白名单列表。

string

互联网 IPv4 白名单。

  • 当白名单类型为自定义输入时:地址簿名称。

  • 当白名单类型为地址簿引用时:IPv4。

10.10.200.4/32

Ipv6Whitelists

array<object>

互联网边界 IPv6 的入侵防御系统白名单列表。

object

互联网边界 IPv6 的入侵防御系统白名单。

Direction

integer

互联网边界的 IPv6 流量方向。

枚举值:

  • 1 :

    入向

  • 2 :

    出向

1

WhiteType

integer

互联网边界 IPv6 白名单生效的源或目的类型。

枚举值:

  • 1 :

    目的 IP 白名单

  • 2 :

    源 IP 白名单

2

ListValue

string

互联网边界 IPv6 白名单的值。

  • 当白名单类型为自定义输入时:地址簿名称。

  • 当白名单类型为地址簿引用时:IPv6。

2408:400a:81a:7900:a77d:ea36:fcbf:de40/128

ListType

integer

互联网 IPv6 白名单地址的类型。

枚举值:

  • 0 :

    暂不设置

  • 1 :

    自定义输入

  • 2 :

    地址簿引用

0

WhiteListValue

array

互联网 IPv6 白名单列表。

string

互联网 IPv6 白名单。

  • 当白名单类型为自定义输入时:地址簿名称。

  • 当白名单类型为地址簿引用时:IPv6。

2408:400a:81a:7900:a77d:ea36:fcbf:de40/128

示例

正常返回示例

JSON格式

{
  "RequestId": "04F788A5-6A47-5EA9-AC30-CA4DB98AD520",
  "Whitelists": [
    {
      "Direction": 1,
      "WhiteType": 1,
      "ListValue": "10.10.200.4/32,10.10.200.25/32",
      "ListType": 1,
      "WhiteListValue": [
        "10.10.200.4/32"
      ]
    }
  ],
  "Ipv6Whitelists": [
    {
      "Direction": 1,
      "WhiteType": 2,
      "ListValue": "2408:400a:81a:7900:a77d:ea36:fcbf:de40/128",
      "ListType": 0,
      "WhiteListValue": [
        "2408:400a:81a:7900:a77d:ea36:fcbf:de40/128\n"
      ]
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 ErrorParametersUid invalid aliUid. 无效的Aliuid。
400 ErrorDBSelect An error occurred while querying database. 内部错误:数据库查询错误
400 ErrorMarshalJSON internal error: marshal json. 请求错误,请稍后重试。

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

变更历史

更多信息,参考变更详情