全部产品
Search
文档中心

云原生数据库 PolarDB:DescribeGlobalSecurityIPGroup - 查询全局IP白名单模板列表

更新时间:Jun 17, 2024

查询全局IP白名单模板列表。

调试

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

授权信息

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

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

请求参数

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

资源组 ID。

rg-************
RegionIdstring

地域 ID。

cn-hangzhou
GlobalSecurityGroupIdstring

IP 白名单模板 ID。

g-zsldxfiwjmti0kcm****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

9B7BFB11-C077-4FE3-B051-F69CEB******
GlobalSecurityIPGroupobject []

全局 IP 白名单模板信息。

GlobalSecurityGroupIdstring

IP 白名单模板 ID。

g-zsldxfiwjmti0kcm****
GlobalIgNamestring

IP 白名单模板名称。IP 白名单模板名称需满足如下要求:

  • 由小写字母、数字、下划线(_)组成。

  • 由字母开头、字母或数字结尾。

  • 长度为 2~120 个字符。

test_123
GIpListstring

白名单模板内的 IP 地址。

说明 多个 IP 地址需要用英文逗号隔开,所有 IP 白名单累积支持添加 1000 个 IP 地址或地址段。
192.168.0.1
RegionIdstring

地域 ID。

cn-hangzhou
DBInstancesarray

已关联 IP 白名单模板的集群列表。

string

关联集群 ID 的集合。

["pc-2zetn0f1b8zwb****","pc-****"]

示例

正常返回示例

JSON格式

{
  "RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******",
  "GlobalSecurityIPGroup": [
    {
      "GlobalSecurityGroupId": "g-zsldxfiwjmti0kcm****",
      "GlobalIgName": "test_123",
      "GIpList": "192.168.0.1",
      "RegionId": "cn-hangzhou",
      "DBInstances": [
        "[\"pc-2zetn0f1b8zwb****\",\"pc-****\"]"
      ]
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400RequiredParam.NotFoundRequired input param is not found.所需的输入参数不存在。
400InvalidActionSpecified action is not valid.指定 action 无效。
404InvalidUser.NotFoundSpecified user does not exist.指定的用户不存在。

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

变更历史

变更时间变更内容概要操作
2023-05-11OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404