文档

DescribeSecurityIps - 查询实例的IP白名单

更新时间:

查询Redis实例的IP白名单。

调试

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

授权信息

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

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

请求参数

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

实例 ID。

r-bp1zxszhcgatnx****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

EFC9161F-15E3-4A6E-8A99-C09916D1****
SecurityIpGroupsobject []

实例的 IP 白名单分组信息。

SecurityIpGroupAttributestring

IP 白名单分组属性,默认为空。

说明 hidden 分组表示经用户授权后,系统(DAS、DMS、DTS 等)自动生成的白名单分组,此类白名单分组不支持修改、删除操作。
hidden
SecurityIpListstring

IP 白名单分组下的 IP 列表,最多 1000 个。

100.100.202.***/24,10.10.10.***
SecurityIpGroupNamestring

IP 白名单分组的名称。

default

示例

正常返回示例

JSON格式

{
  "RequestId": "EFC9161F-15E3-4A6E-8A99-C09916D1****",
  "SecurityIpGroups": {
    "SecurityIpGroup": [
      {
        "SecurityIpGroupAttribute": "hidden",
        "SecurityIpList": "100.100.202.***/24,10.10.10.***",
        "SecurityIpGroupName": "default"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
404InvalidInstanceId.NotFoundThe InstanceId provided does not exist in our records.实例不存在我们的记录中,调用DescribeInstances接口查 看当前用户下面的实例信息

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

变更历史

变更时间变更内容概要操作
2023-08-16OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:404
  • 本页导读 (1)